wasvy 0.0.9

WASI-powered modding for the Bevy engine
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

use bevy_ecs::{prelude::*, query::FilteredAccess};
use bevy_reflect::Reflect;
use serde::Deserialize;

use crate::prelude::{ModSchedules, Sandbox};

/// Represents the access a mod can be given to run in.
///
/// Mods can run in the world and/or in [sandboxes](Sandbox) defined by their entity.
///
/// See: [Mods::enable_access](crate::mods::Mods::enable_access)
#[derive(Reflect, Debug, Eq, PartialEq, Hash, Clone, Copy, Deserialize, Default)]
pub enum ModAccess {
    #[default]
    World,
    Sandbox(Entity),
}

impl ModAccess {
    /// Resolves the schedules configured to run for this mod
    pub fn schedules(&self, world: &World) -> ModSchedules {
        match self {
            Self::Sandbox(entity) => world
                .get::<Sandbox>(*entity)
                .map(|sandbox| sandbox.schedules().clone())
                // The sandbox doesn't exist, so no schedules
                .unwrap_or_else(ModSchedules::empty),
            Self::World => world
                .get_resource::<ModSchedules>()
                .cloned()
                .expect("ModSchedules be registered"),
        }
    }

    /// Returns world access to only the entities granted by this access.
    ///
    /// This is used by Wasvy to build mod systems that don't conflict (can run in parallel) between different accesses.
    pub fn filtered_access(&self, world: &World) -> FilteredAccess {
        match self {
            Self::Sandbox(entity) => world
                .get::<Sandbox>(*entity)
                .map(|sandbox| sandbox.access().clone())
                // The sandbox doesn't exist, so there is nothing to match
                .unwrap_or_else(FilteredAccess::matches_nothing),
            Self::World => Sandbox::access_non_sandboxed(world),
        }
    }

    /// Validates a ModAccess is valid before invoking it
    pub fn validate(&self, world: &World) -> Result<(), String> {
        if let ModAccess::Sandbox(entity) = self
            && world.get::<Sandbox>(*entity).is_none()
        {
            let display = self.display(world);
            Err(format!("ModAccess {display} is not valid"))
        } else {
            Ok(())
        }
    }

    /// Like [std::fmt::Display] but requires world access
    pub fn display(&self, world: &World) -> String {
        match self {
            ModAccess::World => "Main World".into(),
            ModAccess::Sandbox(entity) => match world.get(*entity).map(Name::as_str) {
                Some(name) => format!("Sandbox \"{name}\""),
                None => format!("Sandbox ({entity})"),
            },
        }
    }
}