@kayelaa/canvas 0.1.13 → 0.1.14

package/docs/@kayelaa/namespaces/Kayla/variables/useFiber.md

@@ -1,31 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useFiber
-
-# Variable: useFiber()
-
-> `const` **useFiber**: () => [`UnsafeKaylaFiber`](../interfaces/UnsafeKaylaFiber.md)
-
-Defined in: [kayla-internals.ts:1713](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1713)
-
-**UNSAFE** — Returns direct access to the current `KaylaFiber` instance.
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt ref storage.
-
-**Use with extreme caution** — this exposes internal implementation details.
-Most use-cases should use `useFiberControl()` instead.
-
-Intended only for advanced debugging, testing, or very specific low-level needs.
-
-## Returns
-
-[`UnsafeKaylaFiber`](../interfaces/UnsafeKaylaFiber.md)
-
-The current fiber (may change on refresh — do not cache!)
-
-## See
-
-[useFiberControl](useFiberControl.md) for the safe alternative

package/docs/@kayelaa/namespaces/Kayla/variables/useFiberControl.md

@@ -1,45 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useFiberControl
-
-# Variable: useFiberControl()
-
-> `const` **useFiberControl**: () => [`KaylaFiberControl`](../namespaces/KaylaInternals/interfaces/KaylaFiberControl.md)
-
-Defined in: [kayla-internals.ts:1696](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1696)
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt ref storage.
-
-Returns a safe control surface for the current fiber instance.
-
-Provides limited, controlled access to fiber-level operations:
-- Manually trigger a refresh
-- Read the current number of direct children
-- Set a safety limit on maximum allowed direct children (soft enforcement)
-
-**This is the recommended way** to interact with fiber internals when needed.
-Avoid using `useFiber()` (unsafe) unless you have a very specific reason.
-
-The returned object is stable across refreshes.
-
-## Returns
-
-[`KaylaFiberControl`](../namespaces/KaylaInternals/interfaces/KaylaFiberControl.md)
-
-## Example
-
-```ts
-const control = useFiberControl();
-
-// Force refresh (rarely needed — prefer declarative + useShouldRefresh)
-control.refresh();
-
-// Monitor child count
-if (control.childrenCount > 100) {
-  console.warn("Too many children");
-  control.setMaxChildren(80);
-}
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useInitialization.md

@@ -1,49 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useInitialization
-
-# Variable: useInitialization()
-
-> `const` **useInitialization**: (`init`) => `void`
-
-Defined in: [kayla-internals.ts:1563](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1563)
-
-Runs the provided callback **exactly once** when the entity is first created/mounted.
-
-Unlike `useEffect`, this hook **never re-runs** on subsequent refreshes — even if structural state changes.
-Ideal for true one-time initialization that should survive refreshes:
-- Creating physics bodies / collision shapes
-- Setting up audio contexts / WebGL resources
-- Attaching global event listeners (pointer lock, resize observers)
-- One-time asset preloading or data fetching
-
-If the callback returns a cleanup function, it will be called **only when the entity is finally destroyed** (unuse).
-
-**This hook MUST be called at the top level of a component function.**
-
-## Parameters
-
-### init
-
-() => `void` \| () => `void`
-
-Callback that runs once on first mount. May return a cleanup function.
-
-## Returns
-
-`void`
-
-## Example
-
-```ts
-useInitialization(() => {
-  const audioCtx = new AudioContext();
-  // one-time setup
-
-  return () => {
-    audioCtx.close(); // cleanup only on destroy
-  };
-});
-```

package/docs/@kayelaa/namespaces/Kayla/variables/usePaint.md

@@ -1,31 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / usePaint
-
-# Variable: usePaint()
-
-> `const` **usePaint**: (`onPaint`) => `void`
-
-Defined in: [kayla-internals.ts:1616](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1616)
-
-Registers a callback that runs on every render frame (paint phase).
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt paint registration.
-
-Multiple `usePaint` calls **stack** — all run in declaration order every frame.
-Call `event.preventDefault()` to skip remaining paint handlers (including default rect fill).
-
-**Use for:** drawing sprites, particles, health bars, debug overlays, name tags.
-
-## Parameters
-
-### onPaint
-
-(`ctx`, `event`) => `void`
-
-## Returns
-
-`void`

package/docs/@kayelaa/namespaces/Kayla/variables/useRect.md

@@ -1,38 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useRect
-
-# Variable: useRect()
-
-> `const` **useRect**: () => [`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md)
-
-Defined in: [kayla-internals.ts:1586](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1586)
-
-Returns a stable facade object giving convenient mutable access to the
-current component's underlying rectangle entity properties.
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt ref storage.
-
-The returned object is created only once per entity lifetime and always
-points to the current KaylaRectEntity.
-
-Prefer this over `useEntity()` when you just need position & size.
-
-## Returns
-
-[`KaylaRect`](../namespaces/KaylaInternals/classes/KaylaRect.md)
-
-Facade with `.pos`, `.x`, `.y`, `.width`, `.height`, `.z`, etc.
-
-## Example
-
-```ts
-const rect = useRect();
-useTick(dt => {
-  rect.pos.x += 180 * dt;      // direct Vector2 mutation
-  rect.y += Math.sin(rect.x * 0.01) * 60 * dt;   // alias usage
-});
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useRef.md

@@ -1,83 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useRef
-
-# Variable: useRef()
-
-> `const` **useRef**: \{(`initialValue`): [`KaylaElementRef`](../type-aliases/KaylaElementRef.md); \<`T`\>(`initialValue`): [`KaylaRef`](../interfaces/KaylaRef.md)\<`T`\>; \}
-
-Defined in: [kayla-internals.ts:1497](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1497)
-
-Returns a mutable ref object whose `.current` property persists across entity refreshes.
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt internal ref storage.
-
-Changes to `.current` **never** trigger refresh or re-bind hooks — refs are stable for the entity's lifetime.
-
-**Primary use:** Hold mutable game state, methods, timers, audio nodes, previous values, etc.
-For most entities, wrap your full logic in `useSelf()` instead (strongly recommended pattern).
-
-Special case: pass the `self` symbol to get the current LEA entity:
-
-## Call Signature
-
-> (`initialValue`): [`KaylaElementRef`](../type-aliases/KaylaElementRef.md)
-
-### Parameters
-
-#### initialValue
-
-*typeof* [`self`](self.md)
-
-### Returns
-
-[`KaylaElementRef`](../type-aliases/KaylaElementRef.md)
-
-## Call Signature
-
-> \<`T`\>(`initialValue`): [`KaylaRef`](../interfaces/KaylaRef.md)\<`T`\>
-
-### Type Parameters
-
-#### T
-
-`T`
-
-### Parameters
-
-#### initialValue
-
-`T`
-
-### Returns
-
-[`KaylaRef`](../interfaces/KaylaRef.md)\<`T`\>
-
-## Template
-
-The type of the ref's value
-
-## Param
-
-Initial value for `.current`, or `self` symbol for entity reference
-
-## Returns
-
-A ref object with mutable `.current` property
-
-## Examples
-
-```ts
-Entity reference
-const entity = useRef(self);
-entity.current.x += 10; // direct entity mutation, no refresh
-```
-
-```ts
-Mutable counter
-const timer = useRef(0);
-useTick(delta => { timer.current += delta; });
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useSelf.md

@@ -1,55 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useSelf
-
-# Variable: useSelf()
-
-> `const` **useSelf**: \<`T`\>(`init`) => `T`
-
-Defined in: [kayla-internals.ts:1665](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1665)
-
-Creates and returns a stable object (god-object) for holding most of an entity's state and logic.
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt ref storage.
-
-The initializer runs **only once** (on first entity creation); the returned object is the **same reference** on every refresh.
-
-**Recommended pattern:** Put nearly all mutable state, methods, and game logic here.
-Use `useState` **only** for rare structural changes that should trigger refresh.
-
-## Type Parameters
-
-### T
-
-`T`
-
-The type of the god-object
-
-## Parameters
-
-### init
-
-() => `T`
-
-Factory function returning the object (called only once)
-
-## Returns
-
-`T`
-
-The initialized god-object (stable across refreshes)
-
-## Example
-
-```ts
-const self = useSelf(() => ({
-  pos: new Vector2(400, 300),
-  vel: new Vector2(100, 0),
-  tick(delta) { this.pos.x += this.vel.x * delta; }
-}));
-
-useTick(delta => self.tick(delta));
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useShouldRefresh.md

@@ -1,41 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useShouldRefresh
-
-# Variable: useShouldRefresh()
-
-> `const` **useShouldRefresh**: (`deps`) => `void`
-
-Defined in: [kayla-internals.ts:1516](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1516)
-
-Opt-in: only refresh this component when one of the listed states changes.
-
-Call this **once** at the top level of your component (after all useState calls
-you want to watch).
-
-If none of the watched states change since last refresh → skip re-running
-the component body, hook re-binding, child reconciliation, etc.
-
-## Parameters
-
-### deps
-
-[`KaylaState`](../interfaces/KaylaState.md)\<`any`\>[]
-
-## Returns
-
-`void`
-
-## Example
-
-```ts
-const health   = useState(100);
-const level    = useState(1);
-const isPaused = useState(false);
-
-useShouldRefresh([health, level, isPaused]);
-
-// Now the component only re-runs when one of those actually changes
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useState.md

@@ -1,70 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useState
-
-# Variable: useState()
-
-> `const` **useState**: \<`T`\>(`initialValue?`, `options`) => [`KaylaState`](../interfaces/KaylaState.md)\<`T`\>
-
-Defined in: [kayla-internals.ts:1470](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1470)
-
-Returns a stateful value and a setter to update it.
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed** across every refresh; reordering calls will corrupt internal state.
-
-Calling the setter **may** schedule an entity refresh (re-execution of the component function),
-which re-binds all hooks to the same entity instance and potentially re-spawns children.
-
-**Critical performance warning:**
-**Do NOT** use `useState` for frequently-updated game data (position, velocity, rotation, timers, health deltas, etc.).
-Those **must** live in `useSelf` or plain `useRef`.
-`useState` is **only** for infrequent structural changes that should trigger refresh
-(e.g. `isDead` → spawn particles, `currentLevel` → reload map, `variant` → change sprite sheet).
-
-## Type Parameters
-
-### T
-
-`T`
-
-The type of the state value
-
-## Parameters
-
-### initialValue?
-
-`T`
-
-Optional initial value
-
-### options?
-
-Configuration object
-
-#### alwaysRecall?
-
-`boolean` = `false`
-
-If `true`, **every** `.set()` call triggers a refresh (default: `false`)
-
-## Returns
-
-[`KaylaState`](../interfaces/KaylaState.md)\<`T`\>
-
-A state wrapper with `.get()`, `.set()`, `.add()`, `.multiply()`, and `.lastChanged`
-
-## Examples
-
-```ts
-Correct structural use
-const isDead = useState(false);
-if (health <= 0) isDead.set(true); // → refresh spawns death animation children
-```
-
-```ts
-Incorrect hot-data use (do NOT do this)
-const pos = useState({ x: 400, y: 300 }); // BAD — thrashing + GC pressure
-```

package/docs/@kayelaa/namespaces/Kayla/variables/useTick.md

@@ -1,31 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useTick
-
-# Variable: useTick()
-
-> `const` **useTick**: (`onTick`) => `void`
-
-Defined in: [kayla-internals.ts:1601](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1601)
-
-Registers a callback that runs on every game tick (update phase).
-
-**This hook MUST be called at the top level of a component function — never inside loops, conditions, nested functions, or callbacks.**
-The call order of all hooks is **strictly fixed**; reordering calls will corrupt tick registration.
-
-Multiple `useTick` calls **stack** — all run in declaration order every tick.
-Call `event.preventDefault()` to skip remaining tick handlers for this entity (including default update).
-
-**Use for:** physics, movement, AI, timers, collision checks, input polling.
-
-## Parameters
-
-### onTick
-
-(`deltaS`, `event`) => `void`
-
-## Returns
-
-`void`

package/docs/@kayelaa/namespaces/LEA/README.md

@@ -1,79 +0,0 @@
-[**@kayelaa/canvas**](../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../README.md) / LEA
-
-# LEA
-
-## Namespaces
-
-- [LeaSerializers](namespaces/LeaSerializers/README.md)
-
-## Classes
-
-- [LeaEventEmitter](classes/LeaEventEmitter.md)
-- [LeaRendererII](classes/LeaRendererII.md)
-- [LeaTickerII](classes/LeaTickerII.md)
-- [LeaEntityII](classes/LeaEntityII.md)
-- [LeaSceneII](classes/LeaSceneII.md)
-- [LeaGameII](classes/LeaGameII.md)
-- [DeltaTweenII](classes/DeltaTweenII.md)
-- [RectLeaEntity](classes/RectLeaEntity.md)
-- [LeaTimeout](classes/LeaTimeout.md)
-- [Vector2](classes/Vector2.md)
-- [LiaAudio](classes/LiaAudio.md)
-- [LiaAudioSrc](classes/LiaAudioSrc.md)
-- [LiaOscSFX](classes/LiaOscSFX.md)
-- [GEmitterMemory](classes/GEmitterMemory.md)
-
-## Interfaces
-
-- [SFXConfig](interfaces/SFXConfig.md)
-- [RayHit](interfaces/RayHit.md)
-- [RaycastResult](interfaces/RaycastResult.md)
-
-## Type Aliases
-
-- [Listener](type-aliases/Listener.md)
-- [LeaEntitySerializerEach](type-aliases/LeaEntitySerializerEach.md)
-- [LeaEntitySerializer](type-aliases/LeaEntitySerializer.md)
-- [LeaEntitySerializerArray](type-aliases/LeaEntitySerializerArray.md)
-- [OrderedLeaEntitySerializer](type-aliases/OrderedLeaEntitySerializer.md)
-- [NOTE\_NAME](type-aliases/NOTE_NAME.md)
-- [DefaultWSE](type-aliases/DefaultWSE.md)
-- [Side](type-aliases/Side.md)
-
-## Variables
-
-- [LeaUtilsII](variables/LeaUtilsII.md)
-- [ENVIRONMENT](variables/ENVIRONMENT.md)
-- [isNode](variables/isNode.md)
-- [isWeb](variables/isWeb.md)
-- [NOTE\_NAMES](variables/NOTE_NAMES.md)
-- [defaultSFXConfig](variables/defaultSFXConfig.md)
-- [sfxUIClick](variables/sfxUIClick.md)
-- [sfxUIHover](variables/sfxUIHover.md)
-- [sfxJump](variables/sfxJump.md)
-- [sfxLaser](variables/sfxLaser.md)
-- [sfxHit](variables/sfxHit.md)
-- [LiaSFXMap](variables/LiaSFXMap.md)
-- [isInitiallyMobile](variables/isInitiallyMobile.md)
-
-## Functions
-
-- [getNormalizedColor](functions/getNormalizedColor.md)
-- [colToRGBA](functions/colToRGBA.md)
-- [parseFillStyle](functions/parseFillStyle.md)
-- [editRGBA](functions/editRGBA.md)
-- [scaleCoord](functions/scaleCoord.md)
-- [getEnvironment](functions/getEnvironment.md)
-- [isNote](functions/isNote.md)
-- [shortUID](functions/shortUID.md)
-- [tinyUID](functions/tinyUID.md)
-- [generateUUID](functions/generateUUID.md)
-- [setAnimInterval](functions/setAnimInterval.md)
-- [getRayHit](functions/getRayHit.md)
-- [getAvoidAngle](functions/getAvoidAngle.md)
-- [raycastAvoid](functions/raycastAvoid.md)
-- [isMobile](functions/isMobile.md)