bevy_mod_scripting 0.14.0-alpha.1

Multi language scripting in Bevy
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

use bevy::ecs::reflect::AppTypeRegistry;
use bevy::{app::App, DefaultPlugins};
use bevy_mod_scripting::ScriptFunctionsPlugin;
use bevy_mod_scripting_core::bindings::function::script_function::AppScriptFunctionRegistry;
use bevy_mod_scripting_core::bindings::globals::core::CoreScriptGlobalsPlugin;
use bevy_mod_scripting_core::bindings::globals::AppScriptGlobalsRegistry;
use bevy_mod_scripting_core::BMSScriptingInfrastructurePlugin;
use ladfile_builder::plugin::{generate_lad_file, LadFileSettings, ScriptingDocgenPlugin};

fn main() -> std::io::Result<()> {
    let mut app = App::new();
    // headless bevy, kinda, I want to include as many plugins as I can which actually
    // provide reflected type definitions, but exclude anything that runs rendering stuff.
    app.add_plugins(DefaultPlugins);

    // docgen + scripting
    app.add_plugins((
        // normally the global plugin is included as part of each scripting plugin, here we just take
        // the definitions by themselves
        CoreScriptGlobalsPlugin::default(),
        ScriptFunctionsPlugin,
        BMSScriptingInfrastructurePlugin,
    ));

    // there are two ways to generate the ladfile

    // 1. add the docgen plugin and run your app as normal
    app.add_plugins(ScriptingDocgenPlugin::default());
    app.finish();
    app.cleanup();
    // running update once will do the trick
    // app.update();

    // or 2. manually trigger the system
    // this is what we do here as we're running this example in GHA

    let type_registry = app
        .world()
        .get_resource::<AppTypeRegistry>()
        .unwrap()
        .clone();
    let function_registry = app
        .world()
        .get_resource::<AppScriptFunctionRegistry>()
        .unwrap()
        .clone();
    let global_registry = app
        .world()
        .get_resource::<AppScriptGlobalsRegistry>()
        .unwrap()
        .clone();

    let settings = LadFileSettings {
        description: "Core BMS framework bindings",
        ..Default::default()
    };

    generate_lad_file(
        &type_registry,
        &function_registry,
        &global_registry,
        &settings,
    );

    // bah bye, the generated file will be found in assets/
    // this can then be passed to various backends to generate docs, and other declaration files
    Ok(())
}