yarnspinner_runtime 0.8.0

Runtime / VM for Yarn Spinner for Rust, the 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
61
62
63
64
65
66
67
68
69
70
71

//! Adapted from <https://github.com/YarnSpinnerTool/YarnSpinner/blob/da39c7195107d8211f21c263e4084f773b84eaff/YarnSpinner/YarnSpinner.Markup/MarkupParseResult.cs>
//! which was split into multiple files.

use crate::markup::{MarkupAttributeMarker, MarkupValue};
use crate::prelude::*;
use bevy_platform::collections::HashMap;
use core::fmt::Display;

/// Represents a range of text in a marked-up string.
///
/// You do not create instances of this struct yourself.
/// It is created by [`Dialogue`] in [`Dialogue::continue_`] and passed to you through a [`DialogueEvent`].
///
/// ## See also
/// - [`Line`]
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "bevy", derive(Reflect))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "bevy", reflect(Debug, PartialEq))]
#[cfg_attr(
    all(feature = "bevy", feature = "serde"),
    reflect(Serialize, Deserialize)
)]
pub struct MarkupAttribute {
    /// The name of the attribute.
    pub name: String,
    /// The position in the plain text where this attribute begins.
    pub position: usize,
    /// The number of text elements in the plain text that this attribute covers.
    pub length: usize,
    /// The properties associated with this attribute.
    pub properties: HashMap<String, MarkupValue>,
    /// The position of the marker in the original text.
    pub source_position: usize,
}

impl MarkupAttribute {
    pub(crate) fn from_marker(marker: MarkupAttributeMarker, length: usize) -> Self {
        Self {
            name: marker.name.unwrap(),
            position: marker.position,
            length,
            properties: marker.properties,
            source_position: marker.source_position,
        }
    }

    /// Returns the value of the property with the given name, if it exists.
    /// For examples, the text `Hello [size=20]world[/size]` has a property named `size` with the value `20`.
    pub fn property(&self, name: &str) -> Option<&MarkupValue> {
        self.properties.get(name)
    }
}

impl Display for MarkupAttribute {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let properties = if !self.properties.is_empty() {
            format!(", {} properties", self.properties.len())
        } else {
            String::new()
        };
        write!(
            f,
            "[{name}] - {start}-{end} ({length}{properties})",
            name = self.name,
            start = self.position,
            end = self.position + self.length,
            length = self.length
        )
    }
}