q5play 4.1.0 → 4.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "q5play",
-	"version": "4.1.0",
+	"version": "4.1.2",
 	"author": "quinton-ashley",
 	"license": "SEE LICENSE IN LICENSE.md",
 	"description": "A beginner friendly, web-based game engine that uses q5.js WebGPU for graphics and Box2D v3 WASM for physics.",
@@ -25,6 +25,6 @@
 	},
 	"dependencies": {
 		"box2d3-wasm": "^5.2.0",
-		"q5": "^4.6.3"
+		"q5": "^4.6.6"
 	}
 }

package/q5play.d.ts

@@ -105,6 +105,7 @@ declare global {
 		type: string;
 		geom: any;
 		density: number;
+		applyWind(speed: number, angle: number, drag?: number, lift?: number): void;
 		scaleBy(scaleX: number, scaleY?: number): void;
 		delete(): void;
 	}
@@ -678,11 +679,7 @@ declare global {
 		get rotationDrag(): number;
 		set rotationDrag(val: number);
 		/**
-		 * Known issue, this doesn't work yet.
-		 * https://github.com/q5play/q5play/issues/36
-		 *
 		 * If true, the sprite can not rotate.
-		 * @deprecated
 		 * @default false
 		 */
 		get rotationLock(): boolean;
@@ -870,6 +867,14 @@ declare global {
 		 * @param n The point the force is applied from, relative to the sprite's center of mass. Accepts a coordinate array or object with x and y properties. If not given, the force is applied at the center of mass.
 		 */
 		applyForceScaled(amount: number, origin?: any): void;
+		/**
+		 * Applies wind force to the sprite.
+		 * @param strength the strength of the wind
+		 * @param angle the angle the wind is blowing at
+		 * @param drag the force that opposes the relative velocity
+		 * @param lift the force that is perpendicular to the relative velocity
+		 */
+		applyWind(strength: number, angle: number, drag?: number, lift?: number): void;
 		/**
 		 * Applies a force to the sprite's center of mass attracting it to
 		 * the given position.
@@ -1521,10 +1526,7 @@ declare global {
 		 */
 		rotationDrag: number;
 		/**
-		 * Known issue, this doesn't work.
-		 *
 		 * If true, the group sprites can not rotate.
-		 * @deprecated
 		 */
 		rotationLock: boolean;
 		/**
@@ -1732,6 +1734,7 @@ declare global {
 		passes(target: Group): void;
 		applyForce(amount: number, origin?: [] | { x: number; y: number } | Q5.Vector): void;
 		applyForceScaled(amount: number, origin?: [] | { x: number; y: number } | Q5.Vector): void;
+		applyWind(speed: number, angle: number, drag?: number, lift?: number): void;
 		attractTo(x: number | any, y?: number, force?: number): void;
 		applyTorque(torque: any): void;
 		moveTowards(x: number | any, y?: number, tracking?: number): void;
@@ -1915,8 +1918,7 @@ declare global {
 		set allowSleeping(val: boolean);
 		/**
 		 * Finds the first sprite (with a physics body) that
-		 * intersects a ray (line), excluding any sprites that intersect
-		 * with the starting point.
+		 * intersects a ray (line).
 		 *
 		 * @param startPos starting position of the ray cast
 		 * @param direction direction of the ray
@@ -1926,14 +1928,13 @@ declare global {
 		rayCast(startPos: any, direction: number, maxDistance: number): Sprite;
 		/**
 		 * Finds sprites (with physics bodies) that intersect
-		 * a line (ray), excluding any sprites that intersect the
-		 * starting point.
+		 * a line (ray).
 		 *
 		 * @param startPos starting position of the ray cast
 		 * @param direction direction of the ray
 		 * @param maxDistance max distance the ray should check
-		 * @param limiter limiter function that's run each time the ray intersects a sprite, return true to stop the ray
-		 * @returns An array of sprites that the ray cast hit, sorted by distance. The sprite closest to the starting point will be at index 0.
+		 * @param limiter callback that's run each time the ray intersects a sprite, receives an intersected sprite as an input parameter, return true to stop the ray
+		 * @returns An array of sprites that the ray cast hit, sorted by distance. The sprite closest to the starting point will be at index 0. If a limiter is provided, this array includes the sprite that caused the ray to stop.
 		 */
 		rayCastAll(startPos: any, direction: number, maxDistance: number, limiter?: Function): Sprite[];
 		/**
@@ -2172,10 +2173,12 @@ declare global {
 		set limitsEnabled(val: boolean);
 		/**
 		 * The minimum length allowed when limits are enabled.
+		 * @readonly
 		 */
 		get minLength(): number;
 		/**
 		 * The maximum length allowed when limits are enabled.
+		 * @readonly
 		 */
 		get maxLength(): number;
 		/**
@@ -2354,12 +2357,12 @@ declare global {
 		set limitsEnabled(val: boolean);
 		/**
 		 * The lower limit of rotation.
-		 * @default undefined
+		 * @readonly
 		 */
 		get minAngle(): number;
 		/**
 		 * The upper limit of rotation.
-		 * @default undefined
+		 * @readonly
 		 */
 		get maxAngle(): number;
 		/**
@@ -2453,10 +2456,6 @@ declare global {
 		 * or an array with the lower and upper translation limits.
 		 */
 		set range(val: [number, number] | number);
-		/**
-		 * Alias for range.
-		 */
-		set limits(val: [number, number] | number);
 		/**
 		 * Whether spring behavior is enabled.
 		 * @default false

package/q5play.js

@@ -85,6 +85,7 @@ async function q5playPreSetup(q) {
 		b2World_OverlapShape,
 		b2World_CastRay,
 		b2World_CastRayClosest,
+		b2World_CastShape,
 		b2World_SetCustomFilterCallback,
 		b2World_SetPreSolveCallback,
 		b2World_GetGravity,
@@ -381,7 +382,10 @@ async function q5playPreSetup(q) {
 	$.imageMode($.CENTER);
 
 	const ZERO_VEC = new b2Vec2(0, 0),
-		ZERO_ROT = b2MakeRot(0);
+		ZERO_ROT = b2MakeRot(0),
+		NULL_FILTER = new b2QueryFilter();
+	NULL_FILTER.categoryBits = 0xffffffff;
+	NULL_FILTER.maskBits = 0xffffffff;
 
 	let meterSize = 60;
 
@@ -535,6 +539,12 @@ async function q5playPreSetup(q) {
 			this._density = val;
 			b2Shape_SetDensity(this.id, val);
 		}
+
+		applyWind(strength, angle, drag = 0, lift = 0) {
+			const wind = new b2Vec2(strength * $.cos(angle), strength * $.sin(angle));
+			b2Shape_ApplyWind(this.id, wind, drag, lift, true);
+			wind.delete();
+		}
 	};
 
 	const Sensor = class extends Shape {
@@ -2050,17 +2060,15 @@ async function q5playPreSetup(q) {
 		}
 		set rotationLock(val) {
 			if (this.watch) this.mod[25] = true;
+			this._rotationLock = val;
+			if (!this._physicsEnabled) return;
 
-			// let mass = this.mass;
-
-			// TODO: not working, shape is ignored by physics sim after this
-			let locks = new b2MotionLocks();
+			const locks = new b2MotionLocks();
 			locks.linearX = false;
 			locks.linearY = false;
 			locks.angularZ = val;
 			b2Body_SetMotionLocks(this.bdID, locks);
-
-			// this.mass = mass;
+			locks.delete();
 		}
 
 		get rotationSpeed() {
@@ -2760,6 +2768,14 @@ async function q5playPreSetup(q) {
 			b2Body_ApplyTorque(this.bdID, val, true);
 		}
 
+		applyWind(strength, angle, drag = 0, lift = 0) {
+			const wind = new b2Vec2(strength * $.cos(angle), strength * $.sin(angle));
+			for (let shape of this._shapes) {
+				b2Shape_ApplyWind(shape.id, wind, drag, lift, true);
+			}
+			wind.delete();
+		}
+
 		angleTo(x, y) {
 			if (typeof x == 'object') {
 				y = x.y;
@@ -4464,6 +4480,16 @@ async function q5playPreSetup(q) {
 			}
 		}
 
+		applyWind(strength, angle, drag = 0, lift = 0) {
+			const wind = new b2Vec2(strength * $.cos(angle), strength * $.sin(angle));
+			for (let s of this) {
+				for (let shape of s._shapes) {
+					b2Shape_ApplyWind(shape.id, wind, drag, lift, true);
+				}
+			}
+			wind.delete();
+		}
+
 		_resetCentroid() {
 			let x = 0;
 			let y = 0;
@@ -4784,7 +4810,7 @@ async function q5playPreSetup(q) {
 	$.Visuals.prototype.addAni = $.Group.prototype.addAni = $.Sprite.prototype.addAni;
 	$.Visuals.prototype.addAnis = $.Group.prototype.addAnis = $.Sprite.prototype.addAnis;
 
-	class RayInfo {
+	class CastInfo {
 		constructor(sprite, px, py, nx, ny, fraction, maxDistance) {
 			this.sprite = sprite;
 			this._px = px;
@@ -5075,14 +5101,9 @@ async function q5playPreSetup(q) {
 
 			const point = scaleTo(x, y),
 				proxy = b2MakeProxy(point, 1, radius / meterSize),
-				filter = new b2QueryFilter(),
 				shapes = [];
 
-			// no filter
-			filter.categoryBits = 0xffffffff;
-			filter.maskBits = 0xffffffff;
-
-			b2World_OverlapShape(wID, proxy, filter, (overlapResult) => {
+			b2World_OverlapShape(wID, proxy, NULL_FILTER, (overlapResult) => {
 				const { shapeId } = overlapResult;
 				if (shapeId) {
 					shapes.push(shapeDict[shapeId.index1]);
@@ -5091,7 +5112,6 @@ async function q5playPreSetup(q) {
 			});
 
 			proxy.delete();
-			filter.delete();
 
 			if (!shapes.length) return [];
 
@@ -5179,17 +5199,14 @@ async function q5playPreSetup(q) {
 			const origin = scaleTo(startX, startY);
 			const translation = scaleTo(endX - startX, endY - startY);
 
-			const filter = new b2QueryFilter();
-			filter.categoryBits = 0xffffffff;
-			filter.maskBits = 0xffffffff;
-
 			const results = [];
 
-			b2World_CastRay(wID, origin, translation, filter, (castResult) => {
+			b2World_CastRay(wID, origin, translation, NULL_FILTER, (castResult) => {
 				const shape = shapeDict[castResult.shapeId.index1];
 				if (shape?.sprite) {
 					const s = shape.sprite;
-					s.ray = new RayInfo(
+
+					s.cast = new CastInfo(
 						s,
 						castResult.point.x,
 						castResult.point.y,
@@ -5199,18 +5216,62 @@ async function q5playPreSetup(q) {
 						maxDistance
 					);
 					results.push(s);
+
+					if (limiter && limiter(s)) return 0; // stop raycast
 				}
 				return 1; // continue to collect all hits
 			});
 
-			filter.delete();
-
 			// sort results by distance from start
-			results.sort((a, b) => a.ray.distance - b.ray.distance);
+			results.sort((a, b) => a.cast.distance - b.cast.distance);
+			return results;
+		}
+
+		circleCast(startPos, endPos, radius) {
+			let sprites = this.circleCastAll(startPos, endPos, radius, () => true);
+			return sprites[0];
+		}
+
+		circleCastAll(startPos, endPos, radius, limiter) {
+			const startX = startPos.x ?? startPos[0];
+			const startY = startPos.y ?? startPos[1];
+			const endX = endPos.x ?? endPos[0];
+			const endY = endPos.y ?? endPos[1];
+
+			const maxDistance = Math.sqrt((endX - startX) ** 2 + (endY - startY) ** 2);
+
+			const center = scaleTo(startX, startY);
+			const proxy = b2MakeProxy(center, 1, radius / meterSize);
+			const translation = scaleTo(endX - startX, endY - startY);
 
-			if (!limiter) return results;
+			const results = [];
 
-			return results.filter(limiter);
+			b2World_CastShape(wID, proxy, translation, NULL_FILTER, (castResult) => {
+				const shape = shapeDict[castResult.shapeId.index1];
+				if (shape?.sprite) {
+					const s = shape.sprite;
+
+					s.cast = new CastInfo(
+						s,
+						castResult.point.x,
+						castResult.point.y,
+						castResult.normal.x,
+						castResult.normal.y,
+						castResult.fraction,
+						maxDistance
+					);
+					results.push(s);
+
+					if (limiter && limiter(s)) return 0; // stop cast
+				}
+				return 1; // continue to collect all hits
+			});
+
+			proxy.delete();
+
+			// sort results by distance from start
+			results.sort((a, b) => a.cast.distance - b.cast.distance);
+			return results;
 		}
 	};
 
@@ -5506,7 +5567,7 @@ async function q5playPreSetup(q) {
 		}
 
 		_draw(xA, yA, xB, yB) {
-			if (xB) $.line(xA, yA, xB, yB);
+			if (xB || yB) $.line(xA, yA, xB, yB);
 			else $.point(xA, yA);
 		}
 
@@ -6054,20 +6115,6 @@ async function q5playPreSetup(q) {
 			Box2D.b2PrismaticJoint_EnableLimit(this.jID, true);
 		}
 
-		set limits(val) {
-			let min, max;
-			if (typeof val == 'number') {
-				val /= 2;
-				min = -val;
-				max = val;
-			} else {
-				min = val[0];
-				max = val[1];
-			}
-			Box2D.b2PrismaticJoint_SetLimits(this.jID, min / meterSize, max / meterSize);
-			Box2D.b2PrismaticJoint_EnableLimit(this.jID, true);
-		}
-
 		get springEnabled() {
 			return Box2D.b2PrismaticJoint_IsSpringEnabled(this.jID);
 		}