souprune 0.5.1

A game framework designed specifically for Deltarune / Undertale fangames.
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
106

//! # config.rs
//!
//! # config.rs 文件
//!
//! ## Module Overview
//!
//! ## 模块概述
//!
//! Defines `TomlConfigRegistry`, a resource that aggregates and manages TOML-based configurations for sprites, animations, and module dependencies from all loaded assets.
//!
//! 定义 `TomlConfigRegistry`，该资源聚合和管理来自所有加载资产的基于 TOML 的配置，包括精灵、动画和模块依赖关系。

use crate::extra::toml::{AnimationConfig, SpriteConfig};
use bevy::log::info;
use bevy::platform::collections::HashMap;
use bevy::prelude::Resource;

/// A resource that stores TOML configuration data for all modules
///
/// 存储所有模块 TOML 配置数据的资源
#[derive(Resource, Default)]
pub struct TomlConfigRegistry {
    pub sprite_animations: HashMap<String, AnimationConfig>,
    pub sprites: HashMap<String, SpriteConfig>,
    pub modules: HashMap<String, Vec<String>>,
    pub registered_modules: std::collections::HashSet<String>,
}

impl TomlConfigRegistry {
    pub fn register_module_config(
        &mut self,
        module_name: &str,
        config: &crate::extra::toml::TomlConfig,
    ) {
        // Check if this module has already been registered
        //
        // 检查此模块是否已注册
        if self.registered_modules.contains(module_name) {
            return;
        }

        for anim in &config.animations {
            self.sprite_animations
                .insert(anim.name.clone(), anim.clone());
        }

        for sprite in &config.sprites {
            self.sprites.insert(sprite.name.clone(), sprite.clone());
        }

        for module in &config.module {
            self.modules
                .insert(module_name.to_string(), module.loaded_before.clone());
        }

        // Mark module as registered
        //
        // 将模块标记为已注册
        self.registered_modules.insert(module_name.to_string());

        info!(
            "Configuration of registered module '{}': {} animations, {} sprites",
            module_name,
            config.animations.len(),
            config.sprites.len()
        );
    }

    /// Get animation configuration by name
    ///
    /// 按名称获取动画配置
    pub fn get_animation(&self, name: &str) -> Option<&AnimationConfig> {
        self.sprite_animations.get(name)
    }

    /// Get sprite configuration by name
    ///
    /// 按名称获取精灵配置
    pub fn get_sprite(&self, name: &str) -> Option<&SpriteConfig> {
        self.sprites.get(name)
    }

    /// Get the dependency list of a module
    ///
    /// 获取模块的依赖列表
    #[allow(dead_code)]
    pub fn get_module_dependencies(&self, module_name: &str) -> Option<&Vec<String>> {
        self.modules.get(module_name)
    }

    /// List all available animation names
    ///
    /// 列出所有可用的动画名称
    #[allow(dead_code)]
    pub fn list_animations(&self) -> Vec<&String> {
        self.sprite_animations.keys().collect()
    }

    /// List all available sprite names
    ///
    /// 列出所有可用的精灵名称
    #[allow(dead_code)]
    pub fn list_sprites(&self) -> Vec<&String> {
        self.sprites.keys().collect()
    }
}