bubbles-dialogue 0.8.0

Lightweight engine-agnostic dialogue runtime for Rust games.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

//! [`Candidate`] and the [`SaliencyStrategy`] trait.

/// A candidate presented to the saliency strategy for selection.
#[derive(Debug, Clone)]
pub struct Candidate<'a> {
    /// Stable id for this variant.
    pub id: &'a str,
    /// Whether this candidate is eligible (guard condition passed, not once-exhausted).
    pub available: bool,
}

/// Selects one candidate from a list of available variants.
///
/// Implement this trait to customise line-group and node-group selection behaviour.
/// Strategies may be stateful (e.g. tracking which variants have been recently shown).
pub trait SaliencyStrategy: Send + Sync + 'static {
    /// Returns the index into `candidates` of the chosen variant, or `None` to skip the group.
    fn select(&mut self, candidates: &[Candidate<'_>]) -> Option<usize>;
}