@byloth/core 2.0.0 → 2.0.1

package/src/models/timers/countdown.ts

@@ -75,10 +75,15 @@ export default class Countdown extends GameLoop
     /**
      * Initializes a new instance of the {@link Countdown} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const countdown = new Countdown(10_000);
      * ```
      *
+     * ---
+     *
      * @param duration
      * The total duration of the countdown in milliseconds.
      *
@@ -140,11 +145,16 @@ export default class Countdown extends GameLoop
      *
      * If the countdown is already running, a {@link RuntimeException} will be thrown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * countdown.onStart(() => { [...] }); // This callback will be executed.
      * countdown.start();
      * ```
      *
+     * ---
+     *
      * @param remainingTime
      * The remaining time to set as default when the countdown starts.  
      * Default is the {@link Countdown.duration} itself.
@@ -169,11 +179,16 @@ export default class Countdown extends GameLoop
      *
      * If the countdown hasn't yet started, a {@link RuntimeException} will be thrown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * countdown.onStop(() => { [...] }); // This callback will be executed.
      * countdown.stop();
      * ```
      *
+     * ---
+     *
      * @param reason
      * The reason why the countdown has stopped.
      *
@@ -194,11 +209,16 @@ export default class Countdown extends GameLoop
     /**
      * Subscribes to the `expire` event of the countdown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * countdown.onExpire(() => { [...] }); // This callback will be executed once the countdown has expired.
      * countdown.start();
      * ```
      *
+     * ---
+     *
      * @param callback The callback that will be executed when the countdown expires.
      *
      * @returns A function that can be used to unsubscribe from the event.
@@ -211,11 +231,16 @@ export default class Countdown extends GameLoop
     /**
      * Subscribes to the `tick` event of the countdown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * countdown.onTick((remainingTime) => { [...] }); // This callback will be executed.
      * countdown.start();
      * ```
      *
+     * ---
+     *
      * @param callback The callback that will be executed when the countdown ticks.
      * @param tickStep
      * The minimum time in milliseconds that must pass from the previous execution of the callback to the next one.

package/src/models/timers/game-loop.ts

@@ -116,10 +116,15 @@ export default class GameLoop
     /**
      * Initializes a new instance of the {@link GameLoop} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const loop = new GameLoop((elapsedTime: number) => { [...] });
      * ```
      *
+     * ---
+     *
      * @param callback The function that will be executed at each iteration of the game loop.
      * @param msIfNotBrowser
      * The interval in milliseconds that will be used if the current environment isn't a browser. Default is `40`.
@@ -164,11 +169,16 @@ export default class GameLoop
      *
      * If the game loop is already running, a {@link RuntimeException} will be thrown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * loop.onStart(() => { [...] }); // This callback will be executed.
      * loop.start();
      * ```
      *
+     * ---
+     *
      * @param elapsedTime The elapsed time to set as default when the game loop starts. Default is `0`.
      */
     public start(elapsedTime = 0): void
@@ -187,6 +197,9 @@ export default class GameLoop
      *
      * If the game loop hasn't yet started, a {@link RuntimeException} will be thrown.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * loop.onStop(() => { [...] }); // This callback will be executed.
      * loop.stop();
@@ -210,10 +223,15 @@ export default class GameLoop
     /**
      * Subscribes to the `start` event of the game loop.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * loop.onStart(() => { console.log("The game loop has started."); });
      * ```
      *
+     * ---
+     *
      * @param callback The function that will be executed when the game loop starts.
      *
      * @returns A function that can be used to unsubscribe from the event.
@@ -226,10 +244,15 @@ export default class GameLoop
     /**
      * Subscribes to the `stop` event of the game loop.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * loop.onStop(() => { console.log("The game loop has stopped."); });
      * ```
      *
+     * ---
+     *
      * @param callback The function that will be executed when the game loop stops.
      *
      * @returns A function that can be used to unsubscribe from the event.

package/src/utils/curve.ts

@@ -13,6 +13,9 @@ export default class Curve
      * Generates a given number of values following a linear curve.  
      * The values are equally spaced and normalized between 0 and 1.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * for (const value of Curve.Linear(5))
      * {
@@ -20,6 +23,8 @@ export default class Curve
      * }
      * ```
      *
+     * ---
+     *
      * @param values The number of values to generate.
      *
      * @returns A {@link SmartIterator} object that generates the values following a linear curve.
@@ -38,6 +43,9 @@ export default class Curve
      * Generates a given number of values following an exponential curve.  
      * The values are equally spaced and normalized between 0 and 1.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * for (const value of Curve.Exponential(6))
      * {
@@ -45,6 +53,8 @@ export default class Curve
      * }
      * ```
      *
+     * ---
+     *
      * @param values The number of values to generate.
      * @param base
      * The base of the exponential curve. Default is `2`.

package/src/utils/random.ts

@@ -12,6 +12,9 @@ export default class Random
     /**
      * Generates a random boolean value.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * if (Random.Boolean())
      * {
@@ -19,6 +22,8 @@ export default class Random
      * }
      * ```
      *
+     * ---
+     *
      * @param ratio
      * The probability of generating `true`.
      *
@@ -34,10 +39,15 @@ export default class Random
     /**
      * Generates a random integer value between `0` (included) and `max` (excluded).
      *
+     * ---
+     *
+     * @example
      * ```ts
      * Random.Integer(5); // 0, 1, 2, 3, 4
      * ```
      *
+     * ---
+     *
      * @param max The maximum value (excluded).
      *
      * @returns A random integer value.
@@ -47,10 +57,15 @@ export default class Random
     /**
      * Generates a random integer value between `min` (included) and `max` (excluded).
      *
+     * ---
+     *
+     * @example
      * ```ts
      * Random.Integer(2, 7); // 2, 3, 4, 5, 6
      * ```
      *
+     * ---
+     *
      * @param min The minimum value (included).
      * @param max The maximum value (excluded).
      *
@@ -67,10 +82,15 @@ export default class Random
     /**
      * Generates a random decimal value between `0` (included) and `1` (excluded).
      *
+     * ---
+     *
+     * @example
      * ```ts
      * Random.Decimal(); // 0.123456789
      * ```
      *
+     * ---
+     *
      * @returns A random decimal value.
      */
     public static Decimal(): number;
@@ -78,10 +98,15 @@ export default class Random
     /**
      * Generates a random decimal value between `0` (included) and `max` (excluded).
      *
+     * ---
+     *
+     * @example
      * ```ts
      * Random.Decimal(5); // 2.3456789
      * ```
      *
+     * ---
+     *
      * @param max The maximum value (excluded).
      *
      * @returns A random decimal value.
@@ -91,10 +116,15 @@ export default class Random
     /**
      * Generates a random decimal value between `min` (included) and `max` (excluded).
      *
+     * ---
+     *
+     * @example
      * ```ts
      * Random.Decimal(2, 7); // 4.56789
      * ```
      *
+     * ---
+     *
      * @param min The minimum value (included).
      * @param max The maximum value (excluded).
      *