isaacscript-common 71.2.1 → 72.0.1

package/src/functions/weighted.ts

@@ -1,17 +1,24 @@
 import type { WeightedArray } from "../types/WeightedArray";
 import { sumArray } from "./array";
 import { getRandomFloat } from "./random";
-import { getRandomSeed } from "./rng";
 import { assertDefined } from "./utils";
 
 /**
  * Get a random value from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
  * first element in the tuple is a value, and the second element in the tuple is a float
  * corresponding to the value's weight.)
+ *
+ * If you want to get an unseeded element, you must explicitly pass `undefined` to the `seedOrRNG`
+ * parameter.
+ *
+ * @param weightedArray The array to pick from.
+ * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
+ *                  a random seed.
  */
 export function getRandomFromWeightedArray<T>(
   weightedArray: WeightedArray<T>,
-  seedOrRNG: Seed | RNG = getRandomSeed(),
+  seedOrRNG: Seed | RNG | undefined,
 ): T {
   const randomIndex = getRandomIndexFromWeightedArray(weightedArray, seedOrRNG);
 
@@ -28,10 +35,18 @@ export function getRandomFromWeightedArray<T>(
  * Get a random index from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
  * first element in the tuple is a value, and the second element in the tuple is a float
  * corresponding to the value's weight.)
+ *
+ * If you want to get an unseeded index, you must explicitly pass `undefined` to the `seedOrRNG`
+ * parameter.
+ *
+ * @param weightedArray The array to pick from.
+ * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
+ *                  a random seed.
  */
 export function getRandomIndexFromWeightedArray<T>(
   weightedArray: WeightedArray<T>,
-  seedOrRNG: Seed | RNG = getRandomSeed(),
+  seedOrRNG: Seed | RNG | undefined,
 ): int {
   if (weightedArray.length === 0) {
     error(