chore: replicate changes of #408

CHANGELOG.md

@@ -1,8 +1,21 @@
-# v4000.0.0 and v3001.0.0
+# v4000.0.0
+
+- Replaced the Separating Axis Theorem (SAT) with the Gilbert–Johnson–Keerthi
+  (GJK) distance algorithm.
+- Added circle and (rotated) ellipse collision shapes.
+- Added an ellipse component.
+- Circle area is no longer a box.
+- Added a fake cursor API
 
-This version is a double release, with a lot of new features and breaking
-changes. v3001 release are focused in backward compatibility with v3000 with the
-features of v4000, while v4000 will have the most features and breaking changes.
+  ```js
+  const myCursor = add([fakeMouse(), sprite("kat"), pos(100, 100)]);
+
+  myCursor.press(); // trigger onClick events if the mouse is over
+  myCursor.release();
+  myCursor.move(vec2(100, 200)); // move as your wish
+  ```
+
+# v4000.0.0 and v3001.0.0
 
 ## Input
 
@@ -187,77 +200,75 @@ obj.scale = vec2(3, 4);
 obj.sprite = "bag";
 ```
 
-- `sprite()` new methods, `getAnim`, `hasAnim`, `getCurAnim()`,
+- added `shuffle()` to shuffle an array. (**v3001/4000**)
 
-```js
-const obj = add([
-    sprite("bean"),
-]);
+  ```js
+  const numbers = [1, 2, 3, 4, 5];
+  shuffle(numbers); // [3, 1, 5, 2, 4]
+  ```
 
-// get the current animation name
-debug.log(obj.getCurAnim().name);
-// check if an animation exists
-debug.log(obj.hasAnim("walk"));
-// get the animation data
-debug.log(obj.getAnim("walk"));
-```
+## Debug mode
 
-## Misc
+- added `outline()`, `shader()`, and `area()` properties to `debug.inspect`.
+- added `KAPLAYOpt.debugKey` for customizing the key used to toggle debug mode.
 
-- (**v3001/4000**) added `loadMusic()` to load streaming audio (doesn't block in
-  loading screen)
-- (**v3001/4000**) added `chooseMultiple()` and `shuffle()` helpers for arrays
-- (**v3001/4000**) added `getSceneName()` to get the current scene name
-- (**v3001/4000**) added `camFlash()` to flash the screen
-- (**v3001/4000**) added `SpriteComp.getCurAnim()` to get the current animation
-  data
-- (**v3001/4000**) added `Color.toArray()` to convert a color to an array
-- added `Vec2.toArray()` to convert a vec2 to an array (eg:
-  player.pos.toArray())
-- (**v3001/4000**) added `Vec2.fromArray()` to convert an array to a vec2 (eg:
-  player.pos = Vec2.fromArray(newPosition))
-- (**v3001/4000**) added `outline()`, `shader()`, and `area()` properties to
-  `debug.inspect` (f1)
-- (**v3001/4000**) added `kaboomOpt.debugKey` for customizing the key used to
-  toggle debug mode
-- (**v3001/4000**) added `GameObjRaw.tags` to get a game object's tags
-- (**v3001/4000**) added `GameObjRaw<SpriteComp>.sprite` property to get the
-  name of the sprite
-- (**v3001/4000**) added `patrol()` component to move along a list of waypoints
-- (**v3001/4000**) added `sentry()` component to notify when certain objects are
-  in sight
-- (**v3001/4000**) added `particles()` component to emit and draw particles
-- (**v3001/4000**) added `NavMesh` class for pathfinding on a mesh
-- (**v3001/4000**) added `navigation()` component to calculate a list of
-  waypoints on a graph
-- (**v3001/4000**) added `animate()` component to animate the properties of an
-  object using keyframes
-- (**v3001/4000**) added effector components: `areaEffector()`,
-  `buoyancyEffector()`, `pointEffector()`, `surfaceEffector()`
-- (**v3001/4000**) added `constantForce()` component
-- (**v3001/4000**) added global raycast function and raycast method to level
-- (**v3001/4000**) added support for textured polygons
-- (**v3001/4000**) added support for concave polygon drawing
-- (**v3001/4000**) added support for arrays in uniforms
-- (**v3001/4000**) added support for texture larger than 2048x2048
-- (**v3001/4000**) added support for gravity direction
-- (**v3001/4000**) added line join (bevel, miter, round) and line caps (square,
-  round)
-- (**v3001/4000**) added quadratic bezier and Catmull-Rom evaluation
-- (**v3001/4000**) added evaluation of the first and second derivatives for all
-  splines
-- (**v3001/4000**) added higher order easing functions linear, steps and
-  cubic-bezier
-- (**v3001/4000**) added `textInput()` component
-- (**v3001/4000**) now you can see custom properties in debug.inspect
+  ```js
+  kaplay({
+      debugKey: "l",
+  });
+  ```
+- added compatibility with custom properties in debug mode
 
-## Bug fixes
+  ```js
+  const obj = add([
+      sprite("bean"),
+      {
+          health: 100, // on debug.inspect
+          damage: 10, // on debug.inspect
+          hp() {
+              this.health -= this.damage;
+          }, // not on debug.inspect
+      },
+  ]);
 
-- **(break)** much typescript definitions was fixed, if you use typescript now
-  maybe you see new errors that make your code strict
-- fix error screen not showing with not Error object
+  // see the custom properties in debug mode
+  debug.inspect = true;
+  ```
+- Now `debug.log()` accepts multiple argument of any type, like `console.log()`.
+
+## Helpers
+
+- added `getSceneName()` to get the current scene name
+- added `Color.toArray()` to convert a color to an array
+- added global raycast function and raycast method to level
+- added support for textured polygons
+- added support for concave polygon drawing
+- added support for arrays in uniforms
+- added support for texture larger than 2048x2048
+- added support for gravity direction
+- added line join (bevel, miter, round) and line caps (square, round)
+- added quadratic bezier and Catmull-Rom evaluation
+- added evaluation of the first and second derivatives for all splines
+- added higher order easing functions linear, steps and cubic-bezier
+
+## TypeScript
+
+- Now you can type `get()` with a type parameter and passing component types.
+  (**v4000**)
+
+  ```ts
+  const player = get<BodyComp>("player");
+  ```
+- Now `Key` also accepts a string as an acceptable value.
+- Now `text()` component doesn't require to pass a string.
+- Now `camScale()` and `camPos()` accept only 1 number as parameter.
+- Now `shake()` can be called without args.
+- Now `loadShader()` and `loadShaderURL()` accepts null for unused parameters.
+- Now `RectCompOpt` accepts a array of numbers for `radius`.
 
-## Deprecated
+## Deprecations
+
+> All changes applies for both v3001 and v4000
 
 - deprecated `kaboom()` in favor of `kaplay()` (you can still use `kaboom*`)
 - deprecated `SpriteComp.curAnim()` in favor of `SpriteComp.getCurAnim().name`

examples/add.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Adding game objects to screen
 
 // Start a KAPLAY game

examples/ai.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Use state() component to handle basic AI
 
 // Start kaboom

examples/animation.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Start kaboom
 kaplay();
 
@@ -174,7 +176,7 @@ console.log(JSON.stringify(serializeAnimation(curvingBean, "root"), "", 2));
 
 /*onDraw(() => {
     drawCurve(t => evaluateCatmullRom(
-        vec2(200, 400),
+        vec2(200, 400),\
         vec2(250, 500),
         vec2(300, 400),
         vec2(350, 500), t), { color: RED })

examples/audio.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // audio playback & control
 
 kaplay({

examples/bench.js

@@ -1,3 +1,5 @@
+// @ts-config
+
 // bench marking sprite rendering performance
 
 kaplay();

examples/binding.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay({
     buttons: {
         "jump": {

examples/burp.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Start the game in burp mode
 kaplay({
     burp: true,

examples/button.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Simple Button UI
 
 kaplay({
@@ -16,6 +18,7 @@ function addButton(txt, p, f) {
         scale(1),
         anchor("center"),
         outline(4),
+        color(0, 0, 0),
     ]);
 
     // add a child object that displays the text

examples/camera.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Adjust camera / viewport
 
 // Start game
@@ -77,7 +79,8 @@ onKeyDown("right", () => player.move(SPEED, 0));
 
 let score = 0;
 
-// Add a ui layer with fixed() component to make the object not affected by camera
+// Add a ui layer with fixed() component to make the object
+// not affected by camera
 const ui = add([
     fixed(),
 ]);
@@ -94,6 +97,7 @@ ui.add([
 ]);
 
 onClick(() => {
-    // Use toWorld() to transform a screen-space coordinate (like mousePos()) to the world-space coordinate, which has the camera transform applied
+    // Use toWorld() to transform a screen-space coordinate (like mousePos()) to
+    // the world-space coordinate, which has the camera transform applied
     addKaboom(toWorld(mousePos()));
 });

examples/children.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay();
 
 loadSprite("bean", "/sprites/bean.png");

examples/collision.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Collision handling
 
 // Start kaboom

examples/component.js

@@ -1,3 +1,4 @@
+// @ts-check
 // Custom component
 
 kaplay();

examples/concert.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // bean is holding a concert to celebrate kaboom2000!
 
 kaplay({

examples/confetti.js

@@ -1,3 +1,7 @@
+// @ts-check
+
+kaplay();
+
 const DEF_COUNT = 80;
 const DEF_GRAVITY = 800;
 const DEF_AIR_DRAG = 0.9;
@@ -9,8 +13,6 @@ const DEF_SPIN = [2, 8];
 const DEF_SATURATION = 0.7;
 const DEF_LIGHTNESS = 0.6;
 
-kaplay();
-
 add([
     text("click for confetti"),
     anchor("top"),

examples/curves.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay();
 
 function addPoint(c, ...args) {

examples/dialog.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Simple dialogues with character avatars
 
 kaplay({

examples/doublejump.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay({
     background: [141, 183, 255],
 });
@@ -37,7 +39,7 @@ function spin(speed = 1200) {
 
 scene("game", () => {
     const score = add([
-        text("0", 24),
+        text("0", { size: 24 }),
         pos(24, 24),
         { value: 0 },
     ]);
@@ -111,7 +113,7 @@ scene("game", () => {
         destroy(c);
         play("coin");
         score.value += 1;
-        score.text = score.value;
+        score.text = score.value.toString();
         genCoin(c.idx);
     });
 
@@ -161,7 +163,7 @@ scene("game", () => {
     const timer = add([
         anchor("topright"),
         pos(width() - 24, 24),
-        text(timeLeft),
+        text(timeLeft.toString()),
     ]);
 
     onUpdate(() => {

examples/drag.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Drag & drop interaction
 
 kaplay();

examples/draw.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 // Kaboom as pure rendering lib (no component / game obj etc.)
 
 kaplay();
@@ -26,6 +28,7 @@ const py = 160;
 const doodles = [];
 const trail = [];
 
+/** @type { import("../dist/declaration").Outline } */
 const outline = {
     width: 4,
     color: rgb(0, 0, 0),

examples/easing.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay();
 
 add([

examples/eatlove.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 kaplay();
 
 const fruits = [
@@ -80,7 +82,9 @@ scene("game", () => {
     let score = 0;
 
     const scoreLabel = add([
-        text(score, 32),
+        text(score.toString(), {
+            size: 32,
+        }),
         pos(12, 12),
     ]);
 
@@ -89,7 +93,7 @@ scene("game", () => {
         addKaboom(player.pos);
         score += 1;
         destroy(heart);
-        scoreLabel.text = score;
+        scoreLabel.text = score.toString();
         burp();
         shake(12);
     });