tscratch 0.7.3 → 0.8.0

package/dist/client/index.d.cts

@@ -1,3 +1,13 @@
+interface CameraOptions {
+    x: number;
+    y: number;
+}
+declare class Camera {
+    x: number;
+    y: number;
+    constructor(options?: CameraOptions);
+}
+
 type Vec2<T = number> = [T, T];
 type Vec3<T = number> = [T, T, T];
 type Vec4<T = number> = [T, T, T, T];
@@ -71,56 +81,41 @@ type SceneMap = Map<string, {
     loop: GameLoop | null;
 }>;
 declare class Engine {
-    private static instance;
-    private loopRunning;
-    private gameLoop;
-    maxFPS: number;
-    deltaTime: number;
-    private lastFrame;
-    private refreshScheduled;
-    private animationFrameId;
-    private sounds;
-    mouseX: number;
-    mouseY: number;
-    mouseDown: boolean;
-    mouseClicked: boolean;
-    private keysPressed;
-    private currentScene;
-    sceneMap: SceneMap;
-    private variableMap;
-    static init(): Engine;
-    setScene(scene: string): void;
-    setLoop(scene: string, loop: GameLoop): void;
-    pauseLoop(): void;
-    resumeLoop(): void;
-    addSprite(sprite: Sprite): void;
-    removeSprite(sprite: Sprite): void;
-    setMaxFPS(maxFPS: number): Promise<void>;
-    refresh(): void;
-    wait(ms: number): Promise<void>;
-    waitUntil(conditionGetter: () => boolean): Promise<void>;
-    setVariable<T = any>(key: string, value: T): void;
-    getVariable<T = unknown>(key: string): T;
-    hovering(sprite: Sprite): boolean;
-    keyPressed(key: string): boolean;
-    playSound(src: string): HTMLAudioElement;
-    stopSound(sound: HTMLAudioElement): void;
-    stopAllSounds(): void;
-    pickRandom(min: number, max: number): number;
-    dotProduct(...vectors: [Vec2, Vec2] | [Vec3, Vec3] | [Vec4, Vec4]): number;
-    sin(deg: number): number;
-    cos(deg: number): number;
-    tan(deg: number): number;
-    csc(deg: number): number;
-    sec(deg: number): number;
-    cot(deg: number): number;
-    asin(val: number): number;
-    acos(val: number): number;
-    acsc(val: number): number;
-    asec(val: number): number;
-    toRadians(deg: number): number;
-    toDegrees(rad: number): number;
-    private constructor();
+    private static loopRunning;
+    private static gameLoop;
+    static maxFPS: number;
+    static deltaTime: number;
+    private static lastFrame;
+    private static refreshScheduled;
+    private static animationFrameId;
+    private static sounds;
+    static camera: Camera;
+    static mouseX: number;
+    static mouseY: number;
+    static mouseDown: boolean;
+    static mouseClicked: boolean;
+    private static keysPressed;
+    private static currentScene;
+    static sceneMap: SceneMap;
+    private static variableMap;
+    static init(): void;
+    static setScene(scene: string): void;
+    static setLoop(scene: string, loop: GameLoop): void;
+    static pauseLoop(): void;
+    static resumeLoop(): void;
+    static addSprite(sprite: Sprite): void;
+    static removeSprite(sprite: Sprite): void;
+    static setMaxFPS(maxFPS: number): Promise<void>;
+    static refresh(): void;
+    static wait(ms: number): Promise<void>;
+    static waitUntil(conditionGetter: () => boolean): Promise<void>;
+    static setVariable<T = any>(key: string, value: T): void;
+    static getVariable<T = unknown>(key: string): T;
+    static hovering(sprite: Sprite): boolean;
+    static keyPressed(key: string): boolean;
+    static playSound(src: string): HTMLAudioElement;
+    static stopSound(sound: HTMLAudioElement): void;
+    static stopAllSounds(): void;
 }
 
 declare const canvas: HTMLCanvasElement;
@@ -130,6 +125,39 @@ declare let scale: number;
 declare function setScale(newScale: number): void;
 declare function setAspectRatio(newAspectRatio: number): void;
 
+declare class TSCMath {
+    private constructor();
+    static pickRandom(min: number, max: number): number;
+    static magnitude(v: Vec2): number;
+    static magnitude(v: Vec3): number;
+    static magnitude(v: Vec4): number;
+    static normalize(v: Vec2): Vec2;
+    static normalize(v: Vec3): Vec3;
+    static normalize(v: Vec4): Vec4;
+    static add(a: Vec2, b: Vec2): Vec2;
+    static add(a: Vec3, b: Vec3): Vec3;
+    static add(a: Vec4, b: Vec4): Vec4;
+    static subtract(a: Vec2, b: Vec2): Vec2;
+    static subtract(a: Vec3, b: Vec3): Vec3;
+    static subtract(a: Vec4, b: Vec4): Vec4;
+    static dot(a: Vec2, b: Vec2): number;
+    static dot(a: Vec3, b: Vec3): number;
+    static dot(a: Vec4, b: Vec4): number;
+    static cross(a: Vec3, b: Vec3): Vec3;
+    static toRadians(deg: number): number;
+    static toDegrees(rad: number): number;
+    static sin(deg: number): number;
+    static cos(deg: number): number;
+    static tan(deg: number): number;
+    static csc(deg: number): number;
+    static sec(deg: number): number;
+    static cot(deg: number): number;
+    static asin(val: number): number;
+    static acos(val: number): number;
+    static acsc(val: number): number;
+    static asec(val: number): number;
+}
+
 declare class Multiplayer {
     private static instance;
     private socket;
@@ -621,27 +649,45 @@ declare class RigidCircle extends Circle implements RigidBodyOptions {
     constructor(options?: RigidCircleOptions);
 }
 
+interface Camera3DOptions {
+    x: number;
+    y: number;
+    z: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
+}
+declare class Camera3D {
+    x: number;
+    y: number;
+    z: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
+    constructor(options?: Camera3DOptions);
+}
+
 interface Object3DOptions {
     vertices: Vec3[];
     faces: [number, number, ...number[]][];
     x?: number;
     y?: number;
     z?: number;
-    rotX?: number;
-    rotY?: number;
-    rotZ?: number;
+    dirX?: number;
+    dirY?: number;
+    dirZ?: number;
     color?: string;
-    scale?: number;
+    size?: number;
 }
 declare class Object3D {
     x: number;
     y: number;
     z: number;
-    rotX: number;
-    rotY: number;
-    rotZ: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
     color: string;
-    scale: number;
+    size: number;
     vertices: Vec3[];
     faces: [number, number, ...number[]][];
     constructor(options: Object3DOptions);
@@ -657,28 +703,40 @@ declare class Object3D {
     };
 }
 
-interface WireframeRenderer3DOptions extends PenOptions {
+interface Renderer3DOptions extends PenOptions {
     objects: Object3D[];
+    camera: Camera3D;
 }
-declare class WireframeRenderer3D extends Pen {
+declare abstract class Renderer3D extends Pen {
     FOV: number;
     ASPECT: number;
     Z_NEAR: number;
     SPEED: number;
     SENSITIVITY: number;
-    camX: number;
-    camY: number;
-    camZ: number;
-    camDirX: number;
-    camDirY: number;
-    camDirZ: number;
+    camera: Camera3D;
     objects: Object3D[];
-    constructor(options: WireframeRenderer3DOptions);
+    constructor(options: Renderer3DOptions);
+    abstract render(): void;
     registerControls(): void;
-    private project;
+    protected project(vertices: Vec3[]): Vec2[];
+}
+
+declare class WireframeRenderer3D extends Renderer3D {
     render(): void;
 }
 
+declare class SolidRenderer3D extends Renderer3D {
+    AMBIENT_LIGHT_INTENSITY: number;
+    DIRECTED_LIGHT_INTENSITY: number;
+    DIRECTED_LIGHT_DIR: Vec3;
+    render(): void;
+    static stringToHSL(color: string): {
+        h: number;
+        s: number;
+        l: number;
+    };
+}
+
 declare class Tetrahedron extends Object3D {
     constructor(options?: Partial<Object3DOptions>);
 }
@@ -703,6 +761,22 @@ declare class Monkey extends Object3D {
     constructor(options?: Partial<Object3DOptions>);
 }
 
+interface CuboidOptions extends Object3DOptions {
+    width: number;
+    height: number;
+    length: number;
+}
+declare class Cuboid extends Object3D {
+    width: number;
+    height: number;
+    length: number;
+    constructor(options?: Partial<CuboidOptions>);
+    private computeVertices;
+    setWidth(width: number): void;
+    setHeight(height: number): void;
+    setLength(length: number): void;
+}
+
 type Mat2<T = number> = [
     [
         T,
@@ -759,7 +833,9 @@ type Mat4<T = number> = [
 
 declare const TScratch: {
     Engine: typeof Engine;
+    Camera: typeof Camera;
     Sprite: typeof Sprite;
+    TSCMath: typeof TSCMath;
     Multiplayer: typeof Multiplayer;
     Rectangle: typeof Rectangle;
     Square: typeof Square;
@@ -774,7 +850,10 @@ declare const TScratch: {
     Watermark: typeof Watermark;
     ImageSprite: typeof ImageSprite;
     RigidCircle: typeof RigidCircle;
+    Camera3D: typeof Camera3D;
+    Renderer3D: typeof Renderer3D;
     WireframeRenderer3D: typeof WireframeRenderer3D;
+    SolidRenderer3D: typeof SolidRenderer3D;
     Object3D: typeof Object3D;
     Tetrahedron: typeof Tetrahedron;
     Cube: typeof Cube;
@@ -782,6 +861,7 @@ declare const TScratch: {
     Icosahedron: typeof Icosahedron;
     Icosphere: typeof Icosphere;
     Monkey: typeof Monkey;
+    Cuboid: typeof Cuboid;
     scale: number;
     aspectRatio: number;
     setScale: typeof setScale;
@@ -790,4 +870,4 @@ declare const TScratch: {
     ctx: CanvasRenderingContext2D;
 };
 
-export { Arc, type ArcOptions, Button, type ButtonOptions, Circle, type CircleOptions, Cube, CustomPolygon, type CustomPolygonOptions, Engine, Icosahedron, Icosphere, ImageSprite, type ImageSpriteOptions, type Mat2, type Mat3, type Mat4, Monkey, Multiplayer, Object3D, type Object3DOptions, Octahedron, Oval, type OvalOptions, Pen, type PenOptions, Rectangle, type RectangleOptions, RegularPolygon, type RegularPolygonOptions, type RigidBodyOptions, RigidCircle, type RigidCircleOptions, Sprite, type SpriteOptions, Square, type SquareOptions, Tetrahedron, Text, type TextOptions, type Vec2, type Vec3, type Vec4, Watermark, type TextOptions as WatermarkOptions, WireframeRenderer3D, type WireframeRenderer3DOptions, aspectRatio, canvas, ctx, TScratch as default, scale, setAspectRatio, setScale };
+export { Arc, type ArcOptions, Button, type ButtonOptions, Camera, Camera3D, type Camera3DOptions, type CameraOptions, Circle, type CircleOptions, Cube, Cuboid, type CuboidOptions, CustomPolygon, type CustomPolygonOptions, Engine, Icosahedron, Icosphere, ImageSprite, type ImageSpriteOptions, type Mat2, type Mat3, type Mat4, Monkey, Multiplayer, Object3D, type Object3DOptions, Octahedron, Oval, type OvalOptions, Pen, type PenOptions, Rectangle, type RectangleOptions, RegularPolygon, type RegularPolygonOptions, Renderer3D, type Renderer3DOptions, type RigidBodyOptions, RigidCircle, type RigidCircleOptions, SolidRenderer3D, Sprite, type SpriteOptions, Square, type SquareOptions, TSCMath, Tetrahedron, Text, type TextOptions, type Vec2, type Vec3, type Vec4, Watermark, type TextOptions as WatermarkOptions, WireframeRenderer3D, aspectRatio, canvas, ctx, TScratch as default, scale, setAspectRatio, setScale };

package/dist/client/index.d.ts

@@ -1,3 +1,13 @@
+interface CameraOptions {
+    x: number;
+    y: number;
+}
+declare class Camera {
+    x: number;
+    y: number;
+    constructor(options?: CameraOptions);
+}
+
 type Vec2<T = number> = [T, T];
 type Vec3<T = number> = [T, T, T];
 type Vec4<T = number> = [T, T, T, T];
@@ -71,56 +81,41 @@ type SceneMap = Map<string, {
     loop: GameLoop | null;
 }>;
 declare class Engine {
-    private static instance;
-    private loopRunning;
-    private gameLoop;
-    maxFPS: number;
-    deltaTime: number;
-    private lastFrame;
-    private refreshScheduled;
-    private animationFrameId;
-    private sounds;
-    mouseX: number;
-    mouseY: number;
-    mouseDown: boolean;
-    mouseClicked: boolean;
-    private keysPressed;
-    private currentScene;
-    sceneMap: SceneMap;
-    private variableMap;
-    static init(): Engine;
-    setScene(scene: string): void;
-    setLoop(scene: string, loop: GameLoop): void;
-    pauseLoop(): void;
-    resumeLoop(): void;
-    addSprite(sprite: Sprite): void;
-    removeSprite(sprite: Sprite): void;
-    setMaxFPS(maxFPS: number): Promise<void>;
-    refresh(): void;
-    wait(ms: number): Promise<void>;
-    waitUntil(conditionGetter: () => boolean): Promise<void>;
-    setVariable<T = any>(key: string, value: T): void;
-    getVariable<T = unknown>(key: string): T;
-    hovering(sprite: Sprite): boolean;
-    keyPressed(key: string): boolean;
-    playSound(src: string): HTMLAudioElement;
-    stopSound(sound: HTMLAudioElement): void;
-    stopAllSounds(): void;
-    pickRandom(min: number, max: number): number;
-    dotProduct(...vectors: [Vec2, Vec2] | [Vec3, Vec3] | [Vec4, Vec4]): number;
-    sin(deg: number): number;
-    cos(deg: number): number;
-    tan(deg: number): number;
-    csc(deg: number): number;
-    sec(deg: number): number;
-    cot(deg: number): number;
-    asin(val: number): number;
-    acos(val: number): number;
-    acsc(val: number): number;
-    asec(val: number): number;
-    toRadians(deg: number): number;
-    toDegrees(rad: number): number;
-    private constructor();
+    private static loopRunning;
+    private static gameLoop;
+    static maxFPS: number;
+    static deltaTime: number;
+    private static lastFrame;
+    private static refreshScheduled;
+    private static animationFrameId;
+    private static sounds;
+    static camera: Camera;
+    static mouseX: number;
+    static mouseY: number;
+    static mouseDown: boolean;
+    static mouseClicked: boolean;
+    private static keysPressed;
+    private static currentScene;
+    static sceneMap: SceneMap;
+    private static variableMap;
+    static init(): void;
+    static setScene(scene: string): void;
+    static setLoop(scene: string, loop: GameLoop): void;
+    static pauseLoop(): void;
+    static resumeLoop(): void;
+    static addSprite(sprite: Sprite): void;
+    static removeSprite(sprite: Sprite): void;
+    static setMaxFPS(maxFPS: number): Promise<void>;
+    static refresh(): void;
+    static wait(ms: number): Promise<void>;
+    static waitUntil(conditionGetter: () => boolean): Promise<void>;
+    static setVariable<T = any>(key: string, value: T): void;
+    static getVariable<T = unknown>(key: string): T;
+    static hovering(sprite: Sprite): boolean;
+    static keyPressed(key: string): boolean;
+    static playSound(src: string): HTMLAudioElement;
+    static stopSound(sound: HTMLAudioElement): void;
+    static stopAllSounds(): void;
 }
 
 declare const canvas: HTMLCanvasElement;
@@ -130,6 +125,39 @@ declare let scale: number;
 declare function setScale(newScale: number): void;
 declare function setAspectRatio(newAspectRatio: number): void;
 
+declare class TSCMath {
+    private constructor();
+    static pickRandom(min: number, max: number): number;
+    static magnitude(v: Vec2): number;
+    static magnitude(v: Vec3): number;
+    static magnitude(v: Vec4): number;
+    static normalize(v: Vec2): Vec2;
+    static normalize(v: Vec3): Vec3;
+    static normalize(v: Vec4): Vec4;
+    static add(a: Vec2, b: Vec2): Vec2;
+    static add(a: Vec3, b: Vec3): Vec3;
+    static add(a: Vec4, b: Vec4): Vec4;
+    static subtract(a: Vec2, b: Vec2): Vec2;
+    static subtract(a: Vec3, b: Vec3): Vec3;
+    static subtract(a: Vec4, b: Vec4): Vec4;
+    static dot(a: Vec2, b: Vec2): number;
+    static dot(a: Vec3, b: Vec3): number;
+    static dot(a: Vec4, b: Vec4): number;
+    static cross(a: Vec3, b: Vec3): Vec3;
+    static toRadians(deg: number): number;
+    static toDegrees(rad: number): number;
+    static sin(deg: number): number;
+    static cos(deg: number): number;
+    static tan(deg: number): number;
+    static csc(deg: number): number;
+    static sec(deg: number): number;
+    static cot(deg: number): number;
+    static asin(val: number): number;
+    static acos(val: number): number;
+    static acsc(val: number): number;
+    static asec(val: number): number;
+}
+
 declare class Multiplayer {
     private static instance;
     private socket;
@@ -621,27 +649,45 @@ declare class RigidCircle extends Circle implements RigidBodyOptions {
     constructor(options?: RigidCircleOptions);
 }
 
+interface Camera3DOptions {
+    x: number;
+    y: number;
+    z: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
+}
+declare class Camera3D {
+    x: number;
+    y: number;
+    z: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
+    constructor(options?: Camera3DOptions);
+}
+
 interface Object3DOptions {
     vertices: Vec3[];
     faces: [number, number, ...number[]][];
     x?: number;
     y?: number;
     z?: number;
-    rotX?: number;
-    rotY?: number;
-    rotZ?: number;
+    dirX?: number;
+    dirY?: number;
+    dirZ?: number;
     color?: string;
-    scale?: number;
+    size?: number;
 }
 declare class Object3D {
     x: number;
     y: number;
     z: number;
-    rotX: number;
-    rotY: number;
-    rotZ: number;
+    dirX: number;
+    dirY: number;
+    dirZ: number;
     color: string;
-    scale: number;
+    size: number;
     vertices: Vec3[];
     faces: [number, number, ...number[]][];
     constructor(options: Object3DOptions);
@@ -657,28 +703,40 @@ declare class Object3D {
     };
 }
 
-interface WireframeRenderer3DOptions extends PenOptions {
+interface Renderer3DOptions extends PenOptions {
     objects: Object3D[];
+    camera: Camera3D;
 }
-declare class WireframeRenderer3D extends Pen {
+declare abstract class Renderer3D extends Pen {
     FOV: number;
     ASPECT: number;
     Z_NEAR: number;
     SPEED: number;
     SENSITIVITY: number;
-    camX: number;
-    camY: number;
-    camZ: number;
-    camDirX: number;
-    camDirY: number;
-    camDirZ: number;
+    camera: Camera3D;
     objects: Object3D[];
-    constructor(options: WireframeRenderer3DOptions);
+    constructor(options: Renderer3DOptions);
+    abstract render(): void;
     registerControls(): void;
-    private project;
+    protected project(vertices: Vec3[]): Vec2[];
+}
+
+declare class WireframeRenderer3D extends Renderer3D {
     render(): void;
 }
 
+declare class SolidRenderer3D extends Renderer3D {
+    AMBIENT_LIGHT_INTENSITY: number;
+    DIRECTED_LIGHT_INTENSITY: number;
+    DIRECTED_LIGHT_DIR: Vec3;
+    render(): void;
+    static stringToHSL(color: string): {
+        h: number;
+        s: number;
+        l: number;
+    };
+}
+
 declare class Tetrahedron extends Object3D {
     constructor(options?: Partial<Object3DOptions>);
 }
@@ -703,6 +761,22 @@ declare class Monkey extends Object3D {
     constructor(options?: Partial<Object3DOptions>);
 }
 
+interface CuboidOptions extends Object3DOptions {
+    width: number;
+    height: number;
+    length: number;
+}
+declare class Cuboid extends Object3D {
+    width: number;
+    height: number;
+    length: number;
+    constructor(options?: Partial<CuboidOptions>);
+    private computeVertices;
+    setWidth(width: number): void;
+    setHeight(height: number): void;
+    setLength(length: number): void;
+}
+
 type Mat2<T = number> = [
     [
         T,
@@ -759,7 +833,9 @@ type Mat4<T = number> = [
 
 declare const TScratch: {
     Engine: typeof Engine;
+    Camera: typeof Camera;
     Sprite: typeof Sprite;
+    TSCMath: typeof TSCMath;
     Multiplayer: typeof Multiplayer;
     Rectangle: typeof Rectangle;
     Square: typeof Square;
@@ -774,7 +850,10 @@ declare const TScratch: {
     Watermark: typeof Watermark;
     ImageSprite: typeof ImageSprite;
     RigidCircle: typeof RigidCircle;
+    Camera3D: typeof Camera3D;
+    Renderer3D: typeof Renderer3D;
     WireframeRenderer3D: typeof WireframeRenderer3D;
+    SolidRenderer3D: typeof SolidRenderer3D;
     Object3D: typeof Object3D;
     Tetrahedron: typeof Tetrahedron;
     Cube: typeof Cube;
@@ -782,6 +861,7 @@ declare const TScratch: {
     Icosahedron: typeof Icosahedron;
     Icosphere: typeof Icosphere;
     Monkey: typeof Monkey;
+    Cuboid: typeof Cuboid;
     scale: number;
     aspectRatio: number;
     setScale: typeof setScale;
@@ -790,4 +870,4 @@ declare const TScratch: {
     ctx: CanvasRenderingContext2D;
 };
 
-export { Arc, type ArcOptions, Button, type ButtonOptions, Circle, type CircleOptions, Cube, CustomPolygon, type CustomPolygonOptions, Engine, Icosahedron, Icosphere, ImageSprite, type ImageSpriteOptions, type Mat2, type Mat3, type Mat4, Monkey, Multiplayer, Object3D, type Object3DOptions, Octahedron, Oval, type OvalOptions, Pen, type PenOptions, Rectangle, type RectangleOptions, RegularPolygon, type RegularPolygonOptions, type RigidBodyOptions, RigidCircle, type RigidCircleOptions, Sprite, type SpriteOptions, Square, type SquareOptions, Tetrahedron, Text, type TextOptions, type Vec2, type Vec3, type Vec4, Watermark, type TextOptions as WatermarkOptions, WireframeRenderer3D, type WireframeRenderer3DOptions, aspectRatio, canvas, ctx, TScratch as default, scale, setAspectRatio, setScale };
+export { Arc, type ArcOptions, Button, type ButtonOptions, Camera, Camera3D, type Camera3DOptions, type CameraOptions, Circle, type CircleOptions, Cube, Cuboid, type CuboidOptions, CustomPolygon, type CustomPolygonOptions, Engine, Icosahedron, Icosphere, ImageSprite, type ImageSpriteOptions, type Mat2, type Mat3, type Mat4, Monkey, Multiplayer, Object3D, type Object3DOptions, Octahedron, Oval, type OvalOptions, Pen, type PenOptions, Rectangle, type RectangleOptions, RegularPolygon, type RegularPolygonOptions, Renderer3D, type Renderer3DOptions, type RigidBodyOptions, RigidCircle, type RigidCircleOptions, SolidRenderer3D, Sprite, type SpriteOptions, Square, type SquareOptions, TSCMath, Tetrahedron, Text, type TextOptions, type Vec2, type Vec3, type Vec4, Watermark, type TextOptions as WatermarkOptions, WireframeRenderer3D, aspectRatio, canvas, ctx, TScratch as default, scale, setAspectRatio, setScale };