Struct bevy_rng::RngPlugin

pub struct RngPlugin { /* fields omitted */ }

RngPlugin allows you to inject a (optionally seeded) random number generator into your systems.

Once the plugin is active, you can use Local<bevy_rng::Rng> to get the rng instance.

Using Local<T> ensures you get a unique copy of the rng for each individual system, which is important, because systems have no deterministic order, which will result in non-deterministic rng results.

You are still responsible for deterministically generating random numbers inside an individual system, which (currently) means you can't generate random numbers when iterating over entities, as entity iteration also isn't ordered currently.

Trait Implementations

impl Clone for RngPlugin

fn clone(&self) -> RngPlugin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RngPlugin

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

Formats the value using the given formatter.

impl Default for RngPlugin

fn default() -> RngPlugin

Returns the "default value" for a type.

impl Eq for RngPlugin

impl From<&'_ str> for RngPlugin

fn from(seed: &str) -> Self

Performs the conversion.

impl From<String> for RngPlugin

fn from(seed: String) -> Self

Performs the conversion.

impl From<u64> for RngPlugin

fn from(seed: u64) -> Self

Performs the conversion.

impl Hash for RngPlugin

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for RngPlugin

fn cmp(&self, other: &RngPlugin) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RngPlugin> for RngPlugin

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<RngPlugin> for RngPlugin

fn partial_cmp(&self, other: &RngPlugin) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Plugin for RngPlugin

fn build(&self, app: &mut AppBuilder)

pub fn name(&self) -> &str

impl StructuralEq for RngPlugin

impl StructuralPartialEq for RngPlugin