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

//! # text.rs
//!
//! # text.rs 文件
//!
//! ## Module Overview
//!
//! ## 模块概述
//!
//! This module handles 3D text rendering using bevy_rich_text3d.
//!
//! 本模块使用 bevy_rich_text3d 处理 3D 文本渲染。
//!
//! ## Source File Overview
//!
//! ## 源文件概述
//!
//! It manages glyph refreshing and visibility control for UI text elements.
//!
//! 管理 UI 文本元素的字形刷新和可见性控制。

use bevy::prelude::*;
use bevy::sprite_render::AlphaMode2d;
use bevy_rich_text3d::{Text3d, TextAtlas};

/// Marker component for newly spawned text that needs glyph refresh
///
/// 新生成文本的标记组件，需要刷新字形
#[derive(Component)]
pub(crate) struct NeedsGlyphRefresh;

/// Marker component for text entities that need material assignment.
///
/// 需要分配材质的文本实体的标记组件。
#[derive(Component)]
pub(crate) struct NeedsTextMaterial;

/// After spawning, change the Text3d string in PreUpdate phase to immediately render glyphs.
///
/// 在 spawn 后，在 PreUpdate 阶段修改 Text3d 字符串以立刻渲染字形。
pub(crate) fn refresh_text_glyphs_system(
    mut commands: Commands,
    mut text_query: Query<(Entity, &mut Text3d), Added<NeedsGlyphRefresh>>,
) {
    for (entity, mut text) in text_query.iter_mut() {
        if let Some(s) = text.get_single_mut() {
            let current = s.clone();
            s.clear();
            *s = current;
        }

        commands.entity(entity).remove::<NeedsGlyphRefresh>();
        debug!("Refreshed glyphs for text entity {:?}", entity);
    }
}

/// Assign proper ColorMaterial to text entities that need it.
/// This fixes the purple box issue for container texts.
///
/// 为需要的文本实体分配正确的 ColorMaterial。
/// 这修复了容器文本的紫色方块问题。
pub(crate) fn assign_text_material_system(
    mut commands: Commands,
    mut color_materials: ResMut<Assets<ColorMaterial>>,
    text_query: Query<Entity, (With<Text3d>, With<NeedsTextMaterial>)>,
) {
    for entity in text_query.iter() {
        let mat = color_materials.add(ColorMaterial {
            texture: Some(TextAtlas::DEFAULT_IMAGE.clone()),
            alpha_mode: AlphaMode2d::Blend,
            ..Default::default()
        });

        commands
            .entity(entity)
            .insert(MeshMaterial2d(mat))
            .remove::<NeedsTextMaterial>();

        debug!("Assigned text material to entity {:?}", entity);
    }
}

/// Show text once mesh is generated.
///
/// 网格生成后显示文本。
type TextMeshQuery<'w, 's> =
    Query<'w, 's, (&'static Mesh2d, &'static mut Visibility), (With<Text3d>, Changed<Mesh2d>)>;

pub(crate) fn show_text_when_ready_system(mut text_query: TextMeshQuery) {
    for (mesh, mut visibility) in text_query.iter_mut() {
        if mesh.0 != Handle::default() && *visibility == Visibility::Hidden {
            *visibility = Visibility::Inherited;
        }
    }
}