bevy_rand 0.15.0

A plugin to integrate rand for ECS optimised RNG for the Bevy game engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

use core::fmt::Debug;

use bevy_ecs::{entity::Entity, query::QueryData};
use bevy_prng::EntropySource;

use crate::{seed::RngSeed, traits::SeedSource};

/// A smart query data wrapper that selects for entities that match the `Rng` type,
/// returning read-only data for the seed and the entity.
#[derive(Debug, QueryData)]
pub struct RngEntity<Rng: EntropySource> {
    seed: &'static RngSeed<Rng>,
    entity: Entity,
}

impl<Rng: EntropySource> RngEntityItem<'_, '_, Rng> {
    /// Return the [`Entity`] of the data
    #[inline]
    pub fn entity(&self) -> Entity {
        self.entity
    }

    /// Get a reference to the [`RngSeed`] component for the given data
    #[inline]
    pub fn seed(&self) -> &RngSeed<Rng> {
        self.seed
    }

    /// Clone the seed from the data
    #[inline]
    pub fn clone_seed(&self) -> Rng::Seed {
        self.seed.clone_seed()
    }
}