bevy_yarnspinner 0.7.0

Bevy plugin for Yarn Spinner for Rust, friendly tool for writing game dialogue
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use crate::prelude::*;
use bevy::prelude::*;

pub(crate) fn inner_dialogue_runner_plugin(_app: &mut App) {}

/// Proxy for some functionality of the [`Dialogue`] used by [`DialogueRunner`].
/// Constructed by [`DialogueRunner::inner`]. Serves advanced use cases.
#[derive(Debug)]
pub struct InnerDialogue<'a>(pub(crate) &'a Dialogue);

/// Mutable proxy for some functionality of the [`Dialogue`] used by [`DialogueRunner`].
/// Constructed by [`DialogueRunner::inner_mut`]. Serves advanced use cases.
#[derive(Debug)]
pub struct InnerDialogueMut<'a>(pub(crate) &'a mut Dialogue);

impl InnerDialogue<'_> {
    /// Proxy for [`Dialogue::node_names`].
    pub fn node_names(&self) -> impl Iterator<Item = &str> {
        self.0.node_names().unwrap()
    }

    /// Proxy for [`Dialogue::get_line_id_for_node`].
    #[must_use]
    pub fn get_line_id_for_node(&self, node_name: &str) -> Option<LineId> {
        self.0.get_line_id_for_node(node_name)
    }

    /// Proxy for [`Dialogue::analyse`].
    #[must_use]
    pub fn analyse(&self, context: &mut YarnAnalysisContext) -> &Self {
        self.0.analyse(context);
        self
    }
}

impl InnerDialogueMut<'_> {
    /// Proxy for [`Dialogue::node_names`].
    pub fn node_names(&self) -> impl Iterator<Item = &str> {
        self.0.node_names().unwrap()
    }

    /// Proxy for [`Dialogue::get_line_id_for_node`]
    #[must_use]
    pub fn get_line_id_for_node(&self, node_name: &str) -> Option<LineId> {
        self.0.get_line_id_for_node(node_name)
    }

    /// Proxy for [`Dialogue::set_node`]
    pub fn set_node(&mut self, name: impl Into<String>) -> Result<&mut Self> {
        self.0.set_node(name)?;
        Ok(self)
    }

    /// Proxy for [`Dialogue::analyse`].
    #[must_use]
    pub fn analyse(&self, context: &mut YarnAnalysisContext) -> &Self {
        self.0.analyse(context);
        self
    }
}