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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use crate::plugin::AssetRoot;
use crate::prelude::*;
#[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
use anyhow::{Result, ensure};
use bevy::prelude::*;
#[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
use glob::glob;
use std::path::PathBuf;

/// Possible sources to load a [`YarnFile`] from.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Reflect)]
pub enum YarnFileSource {
    /// A [`YarnFile`] that is already present in the asset server, addressed by its [`Handle`].
    Handle(Handle<YarnFile>),
    /// A [`YarnFile`] that is already present in memory, created with [`YarnFile::new`].
    InMemory(YarnFile),
    /// A [`YarnFile`] inside the `assets` folder. This will be loaded into the [`AssetServer`].
    /// Use [`YarnFileSource::file`] for convenience.
    File(PathBuf),
    /// A folder inside the `assets` folder which is searched for [`YarnFile`]s recursively, loading all files with the `.yarn` extension into the [`AssetServer`].
    /// Use [`YarnFileSource::folder`] for convenience.
    ///
    /// Not supported on Wasm and Android because Bevy cannot load folders on these platforms.
    #[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
    Folder(PathBuf),
}

impl From<Handle<YarnFile>> for YarnFileSource {
    fn from(handle: Handle<YarnFile>) -> Self {
        Self::Handle(handle)
    }
}

impl From<YarnFile> for YarnFileSource {
    fn from(yarn_file: YarnFile) -> Self {
        Self::InMemory(yarn_file)
    }
}

impl YarnFileSource {
    /// Convenience function to create a [`YarnFileSource::File`] from a path.
    pub fn file(path: impl Into<PathBuf>) -> Self {
        Self::File(path.into())
    }

    /// Convenience function to create a [`YarnFileSource::folder`] from a path.
    /// Panics on Wasm and Android because Bevy cannot load folders on these platforms.
    #[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
    pub fn folder(path: impl Into<PathBuf>) -> Self {
        Self::Folder(path.into())
    }

    pub(crate) fn load(
        &self,
        asset_server: &AssetServer,
        assets: &mut ResMut<Assets<YarnFile>>,
        #[allow(unused_variables, reason = "conditional compilation")] asset_root: &AssetRoot,
    ) -> Result<Vec<Handle<YarnFile>>> {
        match self {
            Self::Handle(handle) => Ok(vec![handle.clone()]),
            Self::InMemory(yarn_file) => Ok(vec![assets.add(yarn_file.clone())]),
            Self::File(path) => Ok(vec![asset_server.load(path.clone())]),
            #[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
            Self::Folder(path) => Self::load_folder(asset_server, path.as_path(), asset_root),
        }
    }

    #[cfg(not(any(target_arch = "wasm32", target_os = "android")))]
    fn load_folder(
        asset_server: &AssetServer,
        path: &std::path::Path,
        asset_root: &AssetRoot,
    ) -> Result<Vec<Handle<YarnFile>>> {
        let path = asset_root.0.join(path);
        ensure!(
            path.is_dir(),
            "Failed to load Yarn file folder {path}.\nHelp: Does the folder exist?",
            path = path.display()
        );
        let handles: Result<Vec<_>> =
            glob(path.join("**/*.yarn").to_str().with_context(|| {
                format!(
                    "Failed to create string from path: {path}",
                    path = path.display(),
                )
            })?)?
            .map(|entry| {
                let full_path = entry?;
                let path = full_path.strip_prefix(&asset_root.0)?;
                let asset_path = path.to_string_lossy().replace('\\', "/");
                Ok(asset_server.load(asset_path))
            })
            .collect();
        let handles = handles?;

        if handles.is_empty() {
            warn!(
                "No Yarn files found in the assets subdirectory {path}, so Yarn Spinner won't be able to do anything this run. \
                        Help: Add some Yarn files to get started.",
                path = path.display()
            );
        }
        Ok(handles)
    }
}