Struct LuaRandomGenerator 

pub struct LuaRandomGenerator;

A deterministic random generator independent from the core games random generator that can be seeded and re-seeded at will. This random generator can be saved and loaded and will maintain its state.

Note this is entirely different from calling math.random() and you should be sure you actually want to use this over calling math.random(). If you aren’t sure if you need to use this over calling math.random() then you probably don’t need to use this.

Implementations

impl LuaRandomGenerator

pub fn object_name(&self) -> &str

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

pub fn valid(&self) -> bool

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

pub fn re_seed(&self, seed: u32)

Re-seeds the random generator with the given value.

Seeds that are close together will produce similar results. Seeds from 0 to 341 will produce the same results.

Trait Implementations

impl Clone for LuaRandomGenerator

fn clone(&self) -> LuaRandomGenerator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaRandomGenerator

impl Debug for LuaRandomGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaRandomGenerator

fn default() -> LuaRandomGenerator

Returns the “default value” for a type.

impl Eq for LuaRandomGenerator

impl From<LuaRandomGenerator> for LuaAny

fn from(_: LuaRandomGenerator) -> Self

Converts to this type from the input type.

impl LuaObject for LuaRandomGenerator

impl PartialEq for LuaRandomGenerator

fn eq(&self, other: &LuaRandomGenerator) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaRandomGenerator