rhai-rand - Random Number Generation, Shuffling and Sampling
rhai-rand is an independent Rhai package that provides:
On crates.io: rhai-rand
On GitHub: rhaiscript/rhai-rand
Package name: RandomPackage
Dependency
┌────────────┐
│ Cargo.toml │
└────────────┘
[dependencies]
rhai = "1.2.0"
rhai-rand = "0.1"
Load Package into Engine
#![allow(unused)] fn main() { use rhai::Engine; use rhai::packages::Package; // needed for 'as_shared_module' use rhai_rand::RandomPackage; let mut engine = Engine::new(); // Create new 'RandomPackage' instance let random = RandomPackage::new(); // Load the package engine.register_global_module(random.as_shared_module()); }
Features
| Feature | Description | Should not be used with Rhai feature |
|---|---|---|
float | enables random floating-point number generation | no_float |
array | enables methods for arrays | no_index |
Package Functions
The following functions are defined:
| Function | Return value | Feature | Description |
|---|---|---|---|
rand | INT | generates a random number | |
rand_float | FLOAT | float | generates a random floating-point number between 0.0 and 1.0 |
rand_bool | bool | generates a random boolean |
Arrays
The following methods are defined for arrays:
| Method | Parameter(s) | Return value | Feature | Description |
|---|---|---|---|---|
shuffle | none | array | shuffles the items in the array | |
sample | none | Dynamic | array | returns a random item from the array |
sample | number of items to sample (empty if ≤ 0, all if ≥ length) | Array | array | returns a non-repeating shuffled random sample of items from the array |