@kayelaa/canvas 0.1.13 → 0.2.0

package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaGame.md

@@ -1,369 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaGame
-
-# Interface: KaylaGame
-
-Defined in: [kayla-internals.ts:164](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L164)
-
-Game instance that coordinates scenes, renderers, and the shared ticker.
-
-## Extends
-
-- [`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md)
-
-## Properties
-
-### scenes
-
-> **scenes**: `Map`\<`string`, [`LeaSceneII`](../../LEA/classes/LeaSceneII.md)\>
-
-Defined in: [lea.ts:1024](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1024)
-
-Map of scenes by name.
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`scenes`](../namespaces/KaylaInternals/classes/KaylaGame.md#scenes)
-
-***
-
-### ticker
-
-> **ticker**: [`LeaTickerII`](../../LEA/classes/LeaTickerII.md)
-
-Defined in: [lea.ts:1028](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1028)
-
-The shared ticker driving updates.
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`ticker`](../namespaces/KaylaInternals/classes/KaylaGame.md#ticker)
-
-***
-
-### width
-
-> **width**: `number`
-
-Defined in: [lea.ts:1058](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1058)
-
-Logical viewport width.
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`width`](../namespaces/KaylaInternals/classes/KaylaGame.md#width)
-
-***
-
-### height
-
-> **height**: `number`
-
-Defined in: [lea.ts:1063](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1063)
-
-Logical viewport height.
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`height`](../namespaces/KaylaInternals/classes/KaylaGame.md#height)
-
-## Accessors
-
-### started
-
-#### Get Signature
-
-> **get** **started**(): `boolean`
-
-Defined in: [kayla-internals.ts:226](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L226)
-
-Whether the game has been started.
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`started`](../namespaces/KaylaInternals/classes/KaylaGame.md#started)
-
-***
-
-### centerX
-
-#### Get Signature
-
-> **get** **centerX**(): `number`
-
-Defined in: [lea.ts:1033](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1033)
-
-Center X of the viewport (width / 2).
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`centerX`](../namespaces/KaylaInternals/classes/KaylaGame.md#centerx)
-
-***
-
-### centerY
-
-#### Get Signature
-
-> **get** **centerY**(): `number`
-
-Defined in: [lea.ts:1039](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1039)
-
-Center Y of the viewport (height / 2).
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`centerY`](../namespaces/KaylaInternals/classes/KaylaGame.md#centery)
-
-***
-
-### left
-
-#### Get Signature
-
-> **get** **left**(): `number`
-
-Defined in: [lea.ts:1042](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1042)
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`left`](../namespaces/KaylaInternals/classes/KaylaGame.md#left)
-
-***
-
-### top
-
-#### Get Signature
-
-> **get** **top**(): `number`
-
-Defined in: [lea.ts:1045](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1045)
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`top`](../namespaces/KaylaInternals/classes/KaylaGame.md#top)
-
-***
-
-### right
-
-#### Get Signature
-
-> **get** **right**(): `number`
-
-Defined in: [lea.ts:1048](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1048)
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`right`](../namespaces/KaylaInternals/classes/KaylaGame.md#right)
-
-***
-
-### bottom
-
-#### Get Signature
-
-> **get** **bottom**(): `number`
-
-Defined in: [lea.ts:1051](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1051)
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`bottom`](../namespaces/KaylaInternals/classes/KaylaGame.md#bottom)
-
-## Methods
-
-### start()
-
-> **start**(): `void`
-
-Defined in: [kayla-internals.ts:233](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L233)
-
-Starts the game: starts all attached renderers and the ticker.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`start`](../namespaces/KaylaInternals/classes/KaylaGame.md#start)
-
-***
-
-### stop()
-
-> **stop**(): `void`
-
-Defined in: [kayla-internals.ts:245](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L245)
-
-Stops the game: stops all attached renderers and the ticker.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`stop`](../namespaces/KaylaInternals/classes/KaylaGame.md#stop)
-
-***
-
-### addRenderer()
-
-> **addRenderer**(`renderer`): `void`
-
-Defined in: [kayla-internals.ts:261](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L261)
-
-Attaches a renderer to the game.
-
-If the game is already started, the renderer is started immediately.
-
-#### Parameters
-
-##### renderer
-
-[`KaylaRenderer`](../namespaces/KaylaInternals/classes/KaylaRenderer.md)
-
-The renderer to attach
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`addRenderer`](../namespaces/KaylaInternals/classes/KaylaGame.md#addrenderer)
-
-***
-
-### deleteRenderer()
-
-> **deleteRenderer**(`renderer`): `void`
-
-Defined in: [kayla-internals.ts:277](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L277)
-
-Detaches a renderer from the game.
-
-If the game is running, the renderer is stopped.
-
-#### Parameters
-
-##### renderer
-
-[`KaylaRenderer`](../namespaces/KaylaInternals/classes/KaylaRenderer.md)
-
-The renderer to detach
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`deleteRenderer`](../namespaces/KaylaInternals/classes/KaylaGame.md#deleterenderer)
-
-***
-
-### addScene()
-
-> **addScene**(`scene`): `void`
-
-Defined in: [lea.ts:1091](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1091)
-
-Adds a scene to the game.
-
-#### Parameters
-
-##### scene
-
-[`LeaSceneII`](../../LEA/classes/LeaSceneII.md)
-
-The scene to add
-
-#### Returns
-
-`void`
-
-#### Throws
-
-If the scene has no name
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`addScene`](../namespaces/KaylaInternals/classes/KaylaGame.md#addscene)
-
-***
-
-### removeScene()
-
-> **removeScene**(`scene`): `void`
-
-Defined in: [lea.ts:1102](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1102)
-
-Removes a scene from the game.
-
-#### Parameters
-
-##### scene
-
-[`LeaSceneII`](../../LEA/classes/LeaSceneII.md)
-
-The scene to remove
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`removeScene`](../namespaces/KaylaInternals/classes/KaylaGame.md#removescene)
-
-***
-
-### now()
-
-> **now**(): `number`
-
-Defined in: [lea.ts:1110](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1110)
-
-Current time in milliseconds (from ticker).
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md).[`now`](../namespaces/KaylaInternals/classes/KaylaGame.md#now)

package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaRect.md

@@ -1,308 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaRect
-
-# Interface: KaylaRect
-
-Defined in: [kayla-internals.ts:204](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L204)
-
-A convenient facade for the rectangle entity associated with the current Kayla component.
-
-Provides direct, mutable access to position, size and basic properties of the underlying
-[LEA.RectLeaEntity](../../LEA/classes/RectLeaEntity.md). Most properties are getters/setters that forward to the internal entity.
-
-**Important notes:**
-- `pos` is a live reference to a [LEA.Vector2](../../LEA/classes/Vector2.md) instance — mutating it (`.x`, `.y`, `.add(...)`, etc.)
-  directly affects the entity's position **without** triggering a component refresh.
-- Changing `width` / `height` affects collision & drawing bounds.
-- `z` controls draw order (higher = drawn later / on top).
-
-## Example
-
-```ts
-const rect = useRect();
-
-// Direct mutation — no refresh
-rect.pos.x += 120 * dt;
-rect.pos.y = 400;
-rect.width = 64;
-rect.z = 10;           // bring to front
-
-// Or use convenience setters
-rect.x = 200;
-rect.y += 5;
-```
-
-## Extends
-
-- [`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md)
-
-## Accessors
-
-### pos
-
-#### Get Signature
-
-> **get** **pos**(): [`Vector2`](../../LEA/classes/Vector2.md)
-
-Defined in: [kayla-internals.ts:1310](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1310)
-
-The position of the rectangle's top-left corner (or center, depending on LEA's origin convention).
-
-This is a **live reference** to a [LEA.Vector2](../../LEA/classes/Vector2.md) instance.
-Mutating `.x`, `.y`,
-Using Vector2 methods (`.add()`, `.sub()`, `.scale()`, etc.) will NEVER mutate the vector unless the `.override(x, y)`
-immediately updates the entity's position **without** causing a component refresh.
-
-##### Returns
-
-[`Vector2`](../../LEA/classes/Vector2.md)
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`pos`](../namespaces/KaylaInternals/classes/KaylaRect.md#pos)
-
-***
-
-### x
-
-#### Get Signature
-
-> **get** **x**(): `number`
-
-Defined in: [kayla-internals.ts:1320](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1320)
-
-X-coordinate of the rectangle (alias for `pos.x`).
-Writing to this property immediately updates `pos.x`.
-
-##### Returns
-
-`number`
-
-#### Set Signature
-
-> **set** **x**(`s`): `void`
-
-Defined in: [kayla-internals.ts:1324](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1324)
-
-##### Parameters
-
-###### s
-
-`number`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`x`](../namespaces/KaylaInternals/classes/KaylaRect.md#x)
-
-***
-
-### y
-
-#### Get Signature
-
-> **get** **y**(): `number`
-
-Defined in: [kayla-internals.ts:1334](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1334)
-
-Y-coordinate of the rectangle (alias for `pos.y`).
-Writing to this property immediately updates `pos.y`.
-
-##### Returns
-
-`number`
-
-#### Set Signature
-
-> **set** **y**(`s`): `void`
-
-Defined in: [kayla-internals.ts:1338](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1338)
-
-##### Parameters
-
-###### s
-
-`number`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`y`](../namespaces/KaylaInternals/classes/KaylaRect.md#y)
-
-***
-
-### width
-
-#### Get Signature
-
-> **get** **width**(): `number`
-
-Defined in: [kayla-internals.ts:1347](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1347)
-
-Width of the rectangle (affects collision & rendering bounds).
-
-##### Returns
-
-`number`
-
-#### Set Signature
-
-> **set** **width**(`s`): `void`
-
-Defined in: [kayla-internals.ts:1351](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1351)
-
-##### Parameters
-
-###### s
-
-`number`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`width`](../namespaces/KaylaInternals/classes/KaylaRect.md#width)
-
-***
-
-### height
-
-#### Get Signature
-
-> **get** **height**(): `number`
-
-Defined in: [kayla-internals.ts:1360](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1360)
-
-Height of the rectangle (affects collision & rendering bounds).
-
-##### Returns
-
-`number`
-
-#### Set Signature
-
-> **set** **height**(`s`): `void`
-
-Defined in: [kayla-internals.ts:1364](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1364)
-
-##### Parameters
-
-###### s
-
-`number`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`height`](../namespaces/KaylaInternals/classes/KaylaRect.md#height)
-
-***
-
-### z
-
-#### Get Signature
-
-> **get** **z**(): `number`
-
-Defined in: [kayla-internals.ts:1375](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1375)
-
-Z-index / draw order.
-Higher values are drawn later (appear on top).
-
-##### Default
-
-```ts
-0
-```
-
-##### Returns
-
-`number`
-
-#### Set Signature
-
-> **set** **z**(`s`): `void`
-
-Defined in: [kayla-internals.ts:1379](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1379)
-
-##### Parameters
-
-###### s
-
-`number`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`z`](../namespaces/KaylaInternals/classes/KaylaRect.md#z)
-
-## Methods
-
-### isCollidingWith()
-
-> **isCollidingWith**(`rect`): `boolean`
-
-Defined in: [kayla-internals.ts:1295](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1295)
-
-Checks whether this rectangle is currently colliding (overlapping or touching) with another rectangle.
-
-Uses axis-aligned bounding box (AABB) collision detection — very fast and suitable for most 2D games.
-
-**Important:**
-- Both rectangles must belong to active entities in the same scene.
-- Collision is based on the current `pos`, `width`, `height` values (no rotation support by default).
-- Touching edges **are** considered colliding (inclusive bounds check).
-- Returns `false` if either entity is missing or not yet mounted.
-
-#### Parameters
-
-##### rect
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md)
-
-#### Returns
-
-`boolean`
-
-`true` if the rectangles overlap or touch, `false` otherwise
-
-#### Example
-
-```ts
-const playerRect = useRect();
-const enemyRect = otherEnemy.exportsRef.current?.rect; // assuming exported via useExports
-
-useTick(dt => {
-  // move player...
-
-  if (enemyRect && playerRect.isCollidingWith(enemyRect)) {
-    // take damage, play sound, etc.
-    playerRect.z = 999; // visual feedback: bring to front
-  }
-});
-```
-
-#### See
-
-[LEA.RectLeaEntity.isCollidingWith](../../LEA/classes/RectLeaEntity.md#iscollidingwith) — the underlying LEA implementation
-
-#### Inherited from
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md).[`isCollidingWith`](../namespaces/KaylaInternals/classes/KaylaRect.md#iscollidingwith)