isaacscript-common
Version:
Helper functions and features for IsaacScript mods.
55 lines • 2.52 kB
TypeScript
/**
* Returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on the high
* end. (This is because the `RNG.RandomFloat` method will never return a value of exactly 1.)
*
* If you want to generate an unseeded number, you must explicitly pass `undefined` to the
* `seedOrRNG` parameter.
*
* @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 declare function getRandom(seedOrRNG: Seed | RNG | undefined): float;
/**
* Returns a random float between min and max.
*
* For example:
*
* ```ts
* const realNumberBetweenOneAndThree = getRandomFloat(1, 3, undefined);
* ```
*
* If you want to generate an unseeded number, you must explicitly pass `undefined` to the
* `seedOrRNG` parameter.
*
* @param min The lower bound for the random number (inclusive).
* @param max The upper bound for the random number (exclusive).
* @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 declare function getRandomFloat(min: int, max: int, seedOrRNG: Seed | RNG | undefined): float;
/**
* Returns a random integer between min and max. It is inclusive on both ends.
*
* For example:
*
* ```ts
* const oneTwoOrThree = getRandomInt(1, 3);
* ```
*
* If you want to generate an unseeded number, you must explicitly pass `undefined` to the
* `seedOrRNG` parameter.
*
* @param min The lower bound for the random number (inclusive).
* @param max The upper bound for the random number (inclusive).
* @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.
* @param exceptions Optional. An array of elements that will be skipped over when getting the
* random integer. For example, a min of 1, a max of 4, and an exceptions array of
* `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
* array.
*/
export declare function getRandomInt(min: int, max: int, seedOrRNG: Seed | RNG | undefined, exceptions?: readonly int[]): int;
//# sourceMappingURL=random.d.ts.map