Struct SpawnTable 

pub struct SpawnTable { /* private fields */ }

A weighted spawn table.

Usage:

let mut table = SpawnTable::new();
table.add(SpawnEntry::new("goblin", "Goblin", SpawnTier::Common));
table.add(SpawnEntry::new("orc", "Orc", SpawnTier::Uncommon).with_depth(3, u32::MAX));
let result = table.roll(&mut rng, 5);

Implementations

impl SpawnTable

pub fn new() -> Self

pub fn add(&mut self, entry: SpawnEntry) -> &mut Self

pub fn add_many(&mut self, entries: Vec<SpawnEntry>) -> &mut Self

Add multiple entries from a slice.

pub fn roll_one( &self, rng: &mut Rng, depth: u32, tag: Option<&str>, ) -> Option<&SpawnEntry>

Roll for a single spawn at depth, optionally filtered by tag.

pub fn roll(&self, rng: &mut Rng, n: usize, depth: u32) -> Vec<SpawnResult>

Roll for n spawns at depth. May return fewer if table is small.

pub fn roll_guaranteed( &self, rng: &mut Rng, depth: u32, tiers: &[SpawnTier], ) -> Vec<SpawnResult>

Roll guaranteeing at least one entry from each tier in tiers.

pub fn by_tag(&self, tag: &str) -> Vec<&SpawnEntry>

Get all entries with a given tag.

pub fn available_at_depth(&self, depth: u32) -> Vec<&SpawnEntry>

Get entries valid for depth, sorted by weight descending.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for SpawnTable

fn clone(&self) -> SpawnTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpawnTable

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

Formats the value using the given formatter.

impl Default for SpawnTable

fn default() -> SpawnTable

Returns the “default value” for a type.