@kayelaa/canvas 0.1.13 → 0.2.0

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

@@ -1,105 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaScene
-
-# Interface: KaylaScene
-
-Defined in: [kayla-internals.ts:170](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L170)
-
-Scene wrapper that manages entity lifecycle and delegates to the underlying LEA scene.
-
-## Extends
-
-- [`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md)
-
-## Methods
-
-### getScene()
-
-> **getScene**(): [`LeaSceneII`](../../LEA/classes/LeaSceneII.md)
-
-Defined in: [kayla-internals.ts:1397](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1397)
-
-Returns the underlying LEA scene instance.
-
-#### Returns
-
-[`LeaSceneII`](../../LEA/classes/LeaSceneII.md)
-
-#### Inherited from
-
-[`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md).[`getScene`](../namespaces/KaylaInternals/classes/KaylaScene.md#getscene)
-
-***
-
-### attachTo()
-
-> **attachTo**(`game`): `void`
-
-Defined in: [kayla-internals.ts:1410](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1410)
-
-Attaches this scene to a game instance.
-
-#### Parameters
-
-##### game
-
-[`LeaGameII`](../../LEA/classes/LeaGameII.md)
-
-The game to attach to
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md).[`attachTo`](../namespaces/KaylaInternals/classes/KaylaScene.md#attachto)
-
-***
-
-### spawn()
-
-> **spawn**(`elem`): `void`
-
-Defined in: [kayla-internals.ts:1422](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1422)
-
-Mounts a root component tree into the scene.
-
-Triggers component execution, entity creation, and hook registration.
-
-#### Parameters
-
-##### elem
-
-[`KaylaElement`](KaylaElement.md)\<`any`\>
-
-Root Kayla element (usually JSX)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md).[`spawn`](../namespaces/KaylaInternals/classes/KaylaScene.md#spawn)
-
-***
-
-### detach()
-
-> **detach**(): `void`
-
-Defined in: [kayla-internals.ts:1430](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1430)
-
-Detaches this scene from its game (if attached).
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md).[`detach`](../namespaces/KaylaInternals/classes/KaylaScene.md#detach)

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

@@ -1,266 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaState
-
-# Interface: KaylaState\<T\>
-
-Defined in: [kayla-internals.ts:149](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L149)
-
-Read-only view of a state value created via `useState`.
-
-Returned by `useState`. Changes via `.set()` / `.add()` / `.multiply()` may trigger
-a component refresh (re-execution of the component function), which can be expensive
-in performance-critical loops.
-
-**Performance warning:** Avoid frequent `.set()` calls in `useTick` / `usePaint` loops.
-Prefer `useSelf` or `useRef` for hot data (position, velocity, timers, counters).
-Use `useState` only for infrequent structural changes (e.g. `isDead`, `currentLevel`).
-
-## Extends
-
-- [`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md)\<`T`\>
-
-## Type Parameters
-
-### T
-
-`T`
-
-Type of the stored value
-
-## Properties
-
-### alwaysRecall
-
-> **alwaysRecall**: `boolean`
-
-Defined in: [kayla-internals.ts:643](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L643)
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`alwaysRecall`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#alwaysrecall)
-
-## Accessors
-
-### value
-
-#### Get Signature
-
-> **get** **value**(): `T`
-
-Defined in: [kayla-internals.ts:752](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L752)
-
-The current value of the state.
-
-Reading this property is always safe and does not trigger side effects.
-
-##### Returns
-
-`T`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`value`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#value)
-
-***
-
-### lastChanged
-
-#### Get Signature
-
-> **get** **lastChanged**(): `number`
-
-Defined in: [kayla-internals.ts:763](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L763)
-
-Timestamp (milliseconds since epoch) of the last time the state was changed via `.set()`.
-
-Useful for dependency tracking or knowing when the value was last mutated.
-
-##### Returns
-
-`number`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`lastChanged`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#lastchanged)
-
-## Methods
-
-### get()
-
-> **get**(`this`): `T`
-
-Defined in: [kayla-internals.ts:655](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L655)
-
-#### Parameters
-
-##### this
-
-`KaylaState`\<`T`\>
-
-#### Returns
-
-`T`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`get`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#get)
-
-***
-
-### \[iterator\]()
-
-> **\[iterator\]**(): `Iterator`\<`never`\>
-
-Defined in: [kayla-internals.ts:659](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L659)
-
-#### Returns
-
-`Iterator`\<`never`\>
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`[iterator]`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#iterator)
-
-***
-
-### refreshBased()
-
-> **refreshBased**(): readonly \[(...`args`) => `void`, `T`\]
-
-Defined in: [kayla-internals.ts:668](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L668)
-
-#### Returns
-
-readonly \[(...`args`) => `void`, `T`\]
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`refreshBased`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#refreshbased)
-
-***
-
-### add()
-
-> **add**(`this`, `added`, `options`): `void`
-
-Defined in: [kayla-internals.ts:682](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L682)
-
-Adds a number to the current value (only available when `T` is `number`).
-
-Convenience method that calls `.set(get() + added)`.
-Behaves exactly like `.set()` regarding refresh overhead.
-
-#### Parameters
-
-##### this
-
-`KaylaState`\<`number`\>
-
-##### added
-
-`number`
-
-Value to add
-
-##### options
-
-Optional control over refresh
-
-###### recall?
-
-`boolean`
-
-Force refresh (default: false)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`add`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#add)
-
-***
-
-### multiply()
-
-> **multiply**(`this`, `added`, `multiplier`): `void`
-
-Defined in: [kayla-internals.ts:700](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L700)
-
-Multiplies the current value by a number (only available when `T` is `number`).
-
-Convenience method that calls `.set(get() * multiplier)`.
-Behaves exactly like `.set()` regarding refresh overhead.
-
-#### Parameters
-
-##### this
-
-`KaylaState`\<`number`\>
-
-##### added
-
-`number`
-
-##### multiplier
-
-Value to multiply by
-
-###### recall?
-
-`boolean`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`multiply`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#multiply)
-
-***
-
-### set()
-
-> **set**(`this`, `s`, `newValue`): `void`
-
-Defined in: [kayla-internals.ts:722](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L722)
-
-Updates the state value.
-
-If the new value differs from the current one (strict `!==` comparison),
-and either `recall: true` is passed or `alwaysRecall` was set at creation,
-this triggers a component refresh.
-
-Refreshing re-runs the entire component function, re-binds hooks,
-and may re-mount/unmount children — avoid in hot paths.
-
-#### Parameters
-
-##### this
-
-`KaylaState`\<`T`\>
-
-##### s
-
-`T`
-
-##### newValue
-
-The new state value
-
-###### recall?
-
-`boolean` = `false`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`KaylaInternalState`](../namespaces/KaylaInternals/classes/KaylaInternalState.md).[`set`](../namespaces/KaylaInternals/classes/KaylaInternalState.md#set)