@dcl/playground-assets 7.6.5-11612701565.commit-a53af9d → 7.6.5-11779322228.commit-9328e04

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/alpha.d.ts CHANGED
@@ -7413,6 +7413,93 @@ export declare type ValueSetOptions<T> = {
7413
7413
  maxElements: number;
7414
7414
  };
7415
7415
 
7416
+ /**
7417
+ * @public
7418
+ * Vector2 is a type and a namespace.
7419
+ * - The namespace contains all types and functions to operates with Vector2
7420
+ * - The type Vector2 is an alias to Vector2.ReadonlyVector2
7421
+ * ```
7422
+ *
7423
+ * // Namespace usage example
7424
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7425
+ *
7426
+ * // Type usage example
7427
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7428
+ * readonlyPosition.x = 0.1 // this FAILS
7429
+ *
7430
+ * // For mutable usage, use `Vector2.Mutable`
7431
+ * const position: Vector2.Mutable = Vector2.One()
7432
+ * position.x = 3.0 // this WORKS
7433
+ * ```
7434
+ */
7435
+ export declare type Vector2 = Vector2.ReadonlyVector2;
7436
+
7437
+ /**
7438
+ * @public
7439
+ * Vector2 is a type and a namespace.
7440
+ * ```
7441
+ * // The namespace contains all types and functions to operates with Vector2
7442
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7443
+ * // The type Vector2 is an alias to Vector2.ReadonlyVector2
7444
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7445
+ * readonlyPosition.x = 0.1 // this FAILS
7446
+ *
7447
+ * // For mutable usage, use `Vector2.Mutable`
7448
+ * const position: Vector2.Mutable = Vector2.One()
7449
+ * position.x = 3.0 // this WORKS
7450
+ * ```
7451
+ */
7452
+ export declare namespace Vector2 {
7453
+ /**
7454
+ * @public
7455
+ * For external use, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7456
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7457
+ */
7458
+ export type ReadonlyVector2 = {
7459
+ readonly x: number;
7460
+ readonly y: number;
7461
+ };
7462
+ /**
7463
+ * @public
7464
+ * For external usage, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7465
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7466
+ */
7467
+ export type MutableVector2 = {
7468
+ x: number;
7469
+ y: number;
7470
+ };
7471
+ /**
7472
+ * @public
7473
+ * Type with `Vector2` for readonly usage, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7474
+ * For mutable, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7475
+ */
7476
+ export type Mutable = MutableVector2;
7477
+ /**
7478
+ * Creates a new Vector2 object from the given x, y (floats) coordinates.
7479
+ * @param x - defines the first coordinates (on X axis)
7480
+ * @param y - defines the second coordinates (on Y axis)
7481
+ */
7482
+ export function create(
7483
+ /**
7484
+ * Defines the first coordinates (on X axis)
7485
+ */
7486
+ x?: number,
7487
+ /**
7488
+ * Defines the second coordinates (on Y axis)
7489
+ */
7490
+ y?: number): MutableVector2;
7491
+ /**
7492
+ * Returns a new Vector2 set to (0.0, 0.0)
7493
+ * @returns a new empty Vector2
7494
+ */
7495
+ export function Zero(): MutableVector2;
7496
+ /**
7497
+ * Returns a new Vector2 set to (1.0, 1.0)
7498
+ * @returns a new unit Vector2
7499
+ */
7500
+ export function One(): MutableVector2;
7501
+ }
7502
+
7416
7503
  /**
7417
7504
  * @public
7418
7505
  * Vector3 is a type and a namespace.
@@ -7508,21 +7595,24 @@ export declare namespace Vector3 {
7508
7595
  */
7509
7596
  export function add(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7510
7597
  /**
7511
- * Add component by component the vector2 into dest
7512
- * @param dest - the first vector and destination of addition
7513
- * @param vector2 - the second vector
7598
+ * Performs addition between vectorA and vectorB and stores the result into result
7599
+ * @param vectorA - the first vector for the addition operation
7600
+ * @param vectorB - the second vector for the addition operation
7601
+ * @param result - the vector where the result of the addition is stored
7514
7602
  */
7515
- export function addToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7603
+ export function addToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7516
7604
  /**
7517
7605
  * Returns a new Vector3 as the result of the substraction of the two given vectors.
7518
7606
  * @returns the resulting vector
7519
7607
  */
7520
7608
  export function subtract(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7521
7609
  /**
7522
- * Returns a new Vector3 as the result of the substraction of the two given vectors.
7523
- * @returns the resulting vector
7610
+ * Performs substraction between vectorA and vectorB and stores the result into result
7611
+ * @param vectorA - the first vector for the substraction operation
7612
+ * @param vectorB - the second vector for the substraction operation
7613
+ * @param result - the vector where the result of the substraction is stored
7524
7614
  */
7525
- export function subtractToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7615
+ export function subtractToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7526
7616
  /**
7527
7617
  * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
7528
7618
  * @param x - defines the x coordinate of the operand
package/dist/beta.d.ts CHANGED
@@ -7380,6 +7380,93 @@ export declare type ValueSetOptions<T> = {
7380
7380
  maxElements: number;
7381
7381
  };
7382
7382
 
7383
+ /**
7384
+ * @public
7385
+ * Vector2 is a type and a namespace.
7386
+ * - The namespace contains all types and functions to operates with Vector2
7387
+ * - The type Vector2 is an alias to Vector2.ReadonlyVector2
7388
+ * ```
7389
+ *
7390
+ * // Namespace usage example
7391
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7392
+ *
7393
+ * // Type usage example
7394
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7395
+ * readonlyPosition.x = 0.1 // this FAILS
7396
+ *
7397
+ * // For mutable usage, use `Vector2.Mutable`
7398
+ * const position: Vector2.Mutable = Vector2.One()
7399
+ * position.x = 3.0 // this WORKS
7400
+ * ```
7401
+ */
7402
+ export declare type Vector2 = Vector2.ReadonlyVector2;
7403
+
7404
+ /**
7405
+ * @public
7406
+ * Vector2 is a type and a namespace.
7407
+ * ```
7408
+ * // The namespace contains all types and functions to operates with Vector2
7409
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7410
+ * // The type Vector2 is an alias to Vector2.ReadonlyVector2
7411
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7412
+ * readonlyPosition.x = 0.1 // this FAILS
7413
+ *
7414
+ * // For mutable usage, use `Vector2.Mutable`
7415
+ * const position: Vector2.Mutable = Vector2.One()
7416
+ * position.x = 3.0 // this WORKS
7417
+ * ```
7418
+ */
7419
+ export declare namespace Vector2 {
7420
+ /**
7421
+ * @public
7422
+ * For external use, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7423
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7424
+ */
7425
+ export type ReadonlyVector2 = {
7426
+ readonly x: number;
7427
+ readonly y: number;
7428
+ };
7429
+ /**
7430
+ * @public
7431
+ * For external usage, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7432
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7433
+ */
7434
+ export type MutableVector2 = {
7435
+ x: number;
7436
+ y: number;
7437
+ };
7438
+ /**
7439
+ * @public
7440
+ * Type with `Vector2` for readonly usage, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7441
+ * For mutable, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7442
+ */
7443
+ export type Mutable = MutableVector2;
7444
+ /**
7445
+ * Creates a new Vector2 object from the given x, y (floats) coordinates.
7446
+ * @param x - defines the first coordinates (on X axis)
7447
+ * @param y - defines the second coordinates (on Y axis)
7448
+ */
7449
+ export function create(
7450
+ /**
7451
+ * Defines the first coordinates (on X axis)
7452
+ */
7453
+ x?: number,
7454
+ /**
7455
+ * Defines the second coordinates (on Y axis)
7456
+ */
7457
+ y?: number): MutableVector2;
7458
+ /**
7459
+ * Returns a new Vector2 set to (0.0, 0.0)
7460
+ * @returns a new empty Vector2
7461
+ */
7462
+ export function Zero(): MutableVector2;
7463
+ /**
7464
+ * Returns a new Vector2 set to (1.0, 1.0)
7465
+ * @returns a new unit Vector2
7466
+ */
7467
+ export function One(): MutableVector2;
7468
+ }
7469
+
7383
7470
  /**
7384
7471
  * @public
7385
7472
  * Vector3 is a type and a namespace.
@@ -7475,21 +7562,24 @@ export declare namespace Vector3 {
7475
7562
  */
7476
7563
  export function add(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7477
7564
  /**
7478
- * Add component by component the vector2 into dest
7479
- * @param dest - the first vector and destination of addition
7480
- * @param vector2 - the second vector
7565
+ * Performs addition between vectorA and vectorB and stores the result into result
7566
+ * @param vectorA - the first vector for the addition operation
7567
+ * @param vectorB - the second vector for the addition operation
7568
+ * @param result - the vector where the result of the addition is stored
7481
7569
  */
7482
- export function addToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7570
+ export function addToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7483
7571
  /**
7484
7572
  * Returns a new Vector3 as the result of the substraction of the two given vectors.
7485
7573
  * @returns the resulting vector
7486
7574
  */
7487
7575
  export function subtract(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7488
7576
  /**
7489
- * Returns a new Vector3 as the result of the substraction of the two given vectors.
7490
- * @returns the resulting vector
7577
+ * Performs substraction between vectorA and vectorB and stores the result into result
7578
+ * @param vectorA - the first vector for the substraction operation
7579
+ * @param vectorB - the second vector for the substraction operation
7580
+ * @param result - the vector where the result of the substraction is stored
7491
7581
  */
7492
- export function subtractToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7582
+ export function subtractToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7493
7583
  /**
7494
7584
  * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
7495
7585
  * @param x - defines the x coordinate of the operand
@@ -7380,6 +7380,93 @@ export declare type ValueSetOptions<T> = {
7380
7380
  maxElements: number;
7381
7381
  };
7382
7382
 
7383
+ /**
7384
+ * @public
7385
+ * Vector2 is a type and a namespace.
7386
+ * - The namespace contains all types and functions to operates with Vector2
7387
+ * - The type Vector2 is an alias to Vector2.ReadonlyVector2
7388
+ * ```
7389
+ *
7390
+ * // Namespace usage example
7391
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7392
+ *
7393
+ * // Type usage example
7394
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7395
+ * readonlyPosition.x = 0.1 // this FAILS
7396
+ *
7397
+ * // For mutable usage, use `Vector2.Mutable`
7398
+ * const position: Vector2.Mutable = Vector2.One()
7399
+ * position.x = 3.0 // this WORKS
7400
+ * ```
7401
+ */
7402
+ export declare type Vector2 = Vector2.ReadonlyVector2;
7403
+
7404
+ /**
7405
+ * @public
7406
+ * Vector2 is a type and a namespace.
7407
+ * ```
7408
+ * // The namespace contains all types and functions to operates with Vector2
7409
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
7410
+ * // The type Vector2 is an alias to Vector2.ReadonlyVector2
7411
+ * const readonlyPosition: Vector2 = Vector2.Zero()
7412
+ * readonlyPosition.x = 0.1 // this FAILS
7413
+ *
7414
+ * // For mutable usage, use `Vector2.Mutable`
7415
+ * const position: Vector2.Mutable = Vector2.One()
7416
+ * position.x = 3.0 // this WORKS
7417
+ * ```
7418
+ */
7419
+ export declare namespace Vector2 {
7420
+ /**
7421
+ * @public
7422
+ * For external use, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7423
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7424
+ */
7425
+ export type ReadonlyVector2 = {
7426
+ readonly x: number;
7427
+ readonly y: number;
7428
+ };
7429
+ /**
7430
+ * @public
7431
+ * For external usage, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7432
+ * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7433
+ */
7434
+ export type MutableVector2 = {
7435
+ x: number;
7436
+ y: number;
7437
+ };
7438
+ /**
7439
+ * @public
7440
+ * Type with `Vector2` for readonly usage, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
7441
+ * For mutable, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
7442
+ */
7443
+ export type Mutable = MutableVector2;
7444
+ /**
7445
+ * Creates a new Vector2 object from the given x, y (floats) coordinates.
7446
+ * @param x - defines the first coordinates (on X axis)
7447
+ * @param y - defines the second coordinates (on Y axis)
7448
+ */
7449
+ export function create(
7450
+ /**
7451
+ * Defines the first coordinates (on X axis)
7452
+ */
7453
+ x?: number,
7454
+ /**
7455
+ * Defines the second coordinates (on Y axis)
7456
+ */
7457
+ y?: number): MutableVector2;
7458
+ /**
7459
+ * Returns a new Vector2 set to (0.0, 0.0)
7460
+ * @returns a new empty Vector2
7461
+ */
7462
+ export function Zero(): MutableVector2;
7463
+ /**
7464
+ * Returns a new Vector2 set to (1.0, 1.0)
7465
+ * @returns a new unit Vector2
7466
+ */
7467
+ export function One(): MutableVector2;
7468
+ }
7469
+
7383
7470
  /**
7384
7471
  * @public
7385
7472
  * Vector3 is a type and a namespace.
@@ -7475,21 +7562,24 @@ export declare namespace Vector3 {
7475
7562
  */
7476
7563
  export function add(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7477
7564
  /**
7478
- * Add component by component the vector2 into dest
7479
- * @param dest - the first vector and destination of addition
7480
- * @param vector2 - the second vector
7565
+ * Performs addition between vectorA and vectorB and stores the result into result
7566
+ * @param vectorA - the first vector for the addition operation
7567
+ * @param vectorB - the second vector for the addition operation
7568
+ * @param result - the vector where the result of the addition is stored
7481
7569
  */
7482
- export function addToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7570
+ export function addToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7483
7571
  /**
7484
7572
  * Returns a new Vector3 as the result of the substraction of the two given vectors.
7485
7573
  * @returns the resulting vector
7486
7574
  */
7487
7575
  export function subtract(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
7488
7576
  /**
7489
- * Returns a new Vector3 as the result of the substraction of the two given vectors.
7490
- * @returns the resulting vector
7577
+ * Performs substraction between vectorA and vectorB and stores the result into result
7578
+ * @param vectorA - the first vector for the substraction operation
7579
+ * @param vectorB - the second vector for the substraction operation
7580
+ * @param result - the vector where the result of the substraction is stored
7491
7581
  */
7492
- export function subtractToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
7582
+ export function subtractToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
7493
7583
  /**
7494
7584
  * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
7495
7585
  * @param x - defines the x coordinate of the operand