@nayan-ui/engine 1.0.0-beta.3 → 1.0.0-beta.5

package/lib/typescript/src/world/effects.d.ts

@@ -1,11 +1,12 @@
 import type { Vec3 } from '../types.js';
-import type { BurstOptions, Color, Entity } from './types.js';
+import { type ColorInput } from './color.js';
+import type { BurstOptions, Entity } from './types.js';
 import type { World } from './World.js';
 /** Shared options of the layered effects (confetti, sparkle, shatter, splash, sparks, explosion). */
 export type EffectOptions = {
     position: Vec3;
-    /** One color, or several to pick from at random. */
-    colors: Color | readonly Color[];
+    /** One color (CSS string or tuple), or several to pick from at random. */
+    colors: ColorInput | readonly ColorInput[];
     /** Typical particle size. */
     size: number;
     /** Top speed. */
@@ -27,7 +28,7 @@ export type EffectOptions = {
 export type DustOptions = {
     position: Vec3;
     /** Start color (alpha is how thick it looks), or several to pick from. */
-    color: Color | readonly Color[];
+    color: ColorInput | readonly ColorInput[];
     /** Puff size at the start. */
     size: number;
     /** Top speed. */
@@ -44,7 +45,7 @@ export type DustOptions = {
     /** How much each puff grows by the end. Default 2. */
     endSize?: number;
     /** Color at the end. Default: a single `color` faded to transparent; several colors keep theirs. */
-    endColor?: Color;
+    endColor?: ColorInput;
     /** Default "puff" (blended); "flame" adds light instead. */
     mesh?: BurstOptions['mesh'];
 };
@@ -52,14 +53,14 @@ export type DustOptions = {
 export type FlashOptions = {
     position: Vec3;
     /** Use channels above 1 to glow (see `effects.hot`). */
-    color: Color;
+    color: ColorInput;
     size: number;
     /** Seconds. Default 0.22. */
     lifetime?: number;
     /** How much it grows by the end. Default 2.2. */
     endSize?: number;
     /** Default: `color` faded to transparent. */
-    endColor?: Color;
+    endColor?: ColorInput;
     /** Default "flame" (adds light); "sphere" or "puff" for a solid or soft flash. */
     mesh?: BurstOptions['mesh'];
     /** Glows drawn at once (slightly scattered when `speed` > 0). Default 1. */
@@ -72,7 +73,7 @@ export type PopOptions = {
     /** Its scale at rest (what it has now): one number, or per axis. */
     scale: number | Vec3;
     /** Its color at rest, to return to after the white flash. Omit to flash `flash` only (or nothing). */
-    color?: Color;
+    color?: ColorInput;
     /** Parts to flash white as well (a group's visible children, whose rest color is white). */
     flash?: readonly Entity[];
     /** Seconds before it starts. Default 0. */
@@ -82,9 +83,9 @@ export type PopOptions = {
 };
 type Rgba = [number, number, number, number];
 /** The same hue, self-lit: its brightest channel lifted to `peak` (above 1 glows, through light, shadow and fog). */
-declare function hot(c: Color, peak?: number, alpha?: number): Rgba;
+declare function hot(input: ColorInput, peak?: number, alpha?: number): Rgba;
 /** Part way (`t`, 0..1) to white, with `alpha`. */
-declare function pale(c: Color, t: number, alpha?: number): Rgba;
+declare function pale(input: ColorInput, t: number, alpha?: number): Rgba;
 declare function flash(world: World, o: FlashOptions): number;
 declare function dust(world: World, o: DustOptions): number;
 /** Celebration confetti: tumbling paper in two layers, a few glinting sparkles, and a pop of light. */
@@ -110,8 +111,8 @@ declare function sparks(world: World, e: EffectOptions): void;
  */
 declare function explosion(world: World, e: Omit<EffectOptions, 'colors'> & {
     colors?: EffectOptions['colors'];
-    debris?: readonly Color[];
-    smoke?: Color;
+    debris?: readonly ColorInput[];
+    smoke?: ColorInput;
 }): void;
 /** The piece swells, flashes white, settles and shrinks away. Resolves when it's gone (despawning it is the caller's). */
 declare function pop(world: World, entity: Entity, o: PopOptions): Promise<void>;

package/lib/typescript/src/world/types.d.ts

@@ -3,6 +3,7 @@ import type { Model } from '../assets/model.js';
 import type { Texture } from '../assets/texture.js';
 import type { Sound } from '../media/audio.js';
 import type { Vec3 } from '../types.js';
+import type { ColorInput } from './color.js';
 /** Opaque entity handle. Handles of despawned entities are safely ignored. */
 export type Entity = number & {
     readonly __entity: unique symbol;
@@ -105,8 +106,11 @@ export type EntityOptions = {
     rotation?: Quat;
     /** A number scales uniformly. Children scale with their parent. Visual only after the body exists. */
     scale?: Vec3 | number;
-    /** Alpha below 1 makes it see-through. Channels above 1 glow: at 2 it's self-lit, ignoring light and shadow (fire, lamps). */
-    color?: Color;
+    /**
+     * A CSS color (`'#FF4757'`, `'rgba(…)'`) or a 0..1 tuple. Alpha below 1 makes it see-through. Tuple
+     * channels above 1 glow: at 2 it's self-lit, ignoring light and shadow (fire, lamps).
+     */
+    color?: ColorInput;
     /** Units per second. */
     velocity?: Vec3;
     /** Sets horizontal speed [x, z] and keeps the vertical one: steer a body and it still falls. */
@@ -141,7 +145,8 @@ export type AnimateTarget = {
     position?: Vec3;
     rotation?: Quat;
     scale?: Vec3 | number;
-    color?: Color;
+    /** A CSS color or a 0..1 tuple. */
+    color?: ColorInput;
     /** Move by this offset from where the animation starts (instead of to a `position`). */
     moveBy?: Vec3;
     /** Turn by these angles (radians around x, y, z) from the starting rotation. 2π spins once; more spins more. */
@@ -200,12 +205,12 @@ export type BurstOptions = {
     lifetime?: number;
     /** Vertical acceleration. Default -9.81 (falls); 0 floats. */
     gravity?: number;
-    /** One color, or up to 4 to pick from at random. Default white. */
-    color?: Color | readonly Color[];
+    /** One color (CSS string or tuple), or up to 4 to pick from at random. Default white. */
+    color?: ColorInput | readonly ColorInput[];
     /** Size at the end of each particle's life, as a multiple of its start size: above 1 grows (smoke), below shrinks (embers). Default 1. */
     endSize?: number;
     /** Color every particle shifts to over its life, e.g. flame to dark red; an alpha below 1 fades it out. Default: keeps its color. */
-    endColor?: Color;
+    endColor?: ColorInput;
 };
 export type CollisionInfo = {
     /** True when the touch started; false when it ended. */