Re-implement changes to rhai and rune, and fix event recipients example

Author: makspll

.github/workflows/bevy_mod_scripting.yml

@@ -26,15 +26,15 @@ jobs:
     strategy:
       matrix:
        run_args: [ 
-        {label: Windows - All Features,        os: windows-latest,      features: "lua54,rhai,teal,lua_script_api,rhai_script_api,rune",      cross: x86_64-pc-windows-msvc    }, 
-        {label: MacOS - All Features,          os: macOS-latest,        features: "lua54,rhai,teal,lua_script_api,rhai_script_api,rune",      cross: x86_64-apple-darwin       },
-        {label: Ubuntu - All Features,         os: ubuntu-latest,       features: "lua54,lua_script_api,rhai,teal,rhai_script_api,rune",      cross: x86_64-unknown-linux-gnu  }, 
-        {label: Ubuntu Aarch64 - All Features, os: ubuntu-latest,       features: "lua54,rhai,teal,lua_script_api,rhai_script_api,rune",      cross: aarch64-unknown-linux-gnu },
-        {label: Ubuntu - Lua51,                os: ubuntu-latest,       features: "lua51,lua_script_api",                                     cross: x86_64-unknown-linux-gnu  }, 
-        {label: Ubuntu - Lua52,                os: ubuntu-latest,       features: "lua52,lua_script_api",                                     cross: x86_64-unknown-linux-gnu  }, 
-        {label: Ubuntu - Lua53,                os: ubuntu-latest,       features: "lua53,lua_script_api",                                     cross: x86_64-unknown-linux-gnu  }, 
-        {label: Ubuntu - Luajit,               os: ubuntu-latest,       features: "luajit,lua_script_api",                                    cross: x86_64-unknown-linux-gnu  }, 
-        {label: Ubuntu - Luajit52,             os: ubuntu-latest,       features: "luajit52,lua_script_api",                                  cross: x86_64-unknown-linux-gnu  }
+        {label: Windows - All Features,        os: windows-latest,      features: "lua54,rhai,teal,rune",      cross: x86_64-pc-windows-msvc    }, 
+        {label: MacOS - All Features,          os: macOS-latest,        features: "lua54,rhai,teal,rune",      cross: x86_64-apple-darwin       },
+        {label: Ubuntu - All Features,         os: ubuntu-latest,       features: "lua54,rhai,teal,rune",      cross: x86_64-unknown-linux-gnu  }, 
+        {label: Ubuntu Aarch64 - All Features, os: ubuntu-latest,       features: "lua54,rhai,teal,rune",      cross: aarch64-unknown-linux-gnu },
+        {label: Ubuntu - Lua51,                os: ubuntu-latest,       features: "lua51",                                     cross: x86_64-unknown-linux-gnu  }, 
+        {label: Ubuntu - Lua52,                os: ubuntu-latest,       features: "lua52",                                     cross: x86_64-unknown-linux-gnu  }, 
+        {label: Ubuntu - Lua53,                os: ubuntu-latest,       features: "lua53",                                     cross: x86_64-unknown-linux-gnu  }, 
+        {label: Ubuntu - Luajit,               os: ubuntu-latest,       features: "luajit",                                    cross: x86_64-unknown-linux-gnu  }, 
+        {label: Ubuntu - Luajit52,             os: ubuntu-latest,       features: "luajit52",                                  cross: x86_64-unknown-linux-gnu  }
       ]
     steps:
       - if: runner.os == 'linux'
@@ -94,7 +94,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --features=lua54,rhai,teal,lua_script_api,rhai_script_api,rune --profile=ephemeral-build -- -D warnings 
+          args: --features=lua54,rhai,teal,rune --profile=ephemeral-build -- -D warnings 
   tests:
     name: Tests
     runs-on: ubuntu-latest
@@ -114,7 +114,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --workspace --features=lua54,rhai,teal,lua_script_api,rhai_script_api,rune --profile=ephemeral-build
+          args: --workspace --features=lua54,rhai,teal,rune --profile=ephemeral-build
   docs:
     name: Docs
     runs-on: ubuntu-latest

.github/workflows/doc_gen.yml

@@ -32,7 +32,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --features=lua54,lua_script_api lua
+          args: --features=lua54 lua
       - run: cat ./assets/scripts/doc/tealr_doc_gen_config.json
       - name: Push to pages
         uses: cpina/github-action-push-to-another-repository@main

.vscode/launch.json

@@ -25,7 +25,7 @@
                     "build",
                     "--example=game_of_life_lua",
                     "--package=bevy_mod_scripting",
-                    "--features=lua54,teal,lua_script_api",
+                    "--features=lua54,teal",
                 ],
                 "filter": {
                     "name": "game_of_life_lua",

Cargo.toml

@@ -21,15 +21,7 @@ name = "bevy_mod_scripting"
 path = "src/lib.rs"
 
 [package.metadata."docs.rs"]
-features = [
-    "lua",
-    "lua54",
-    "rhai",
-    "lua_script_api",
-    "rhai_script_api",
-    "teal",
-    "rune",
-]
+features = ["lua", "lua54", "rhai", "teal", "rune"]
 
 [features]
 ## core
@@ -46,7 +38,6 @@ luajit = ["bevy_mod_scripting_lua/luajit", "lua"]
 luajit52 = ["bevy_mod_scripting_lua/luajit52", "lua"]
 
 # optional
-lua_script_api = ["bevy_script_api/lua"]
 unsafe_lua_modules = ["bevy_mod_scripting_lua/unsafe_lua_modules"]
 teal = ["bevy_mod_scripting_lua/teal"]
 mlua_serialize = ["bevy_mod_scripting_lua/mlua_serialize"]
@@ -55,7 +46,6 @@ mlua_async = ["bevy_mod_scripting_lua/mlua_async"]
 
 ## rhai
 rhai = ["bevy_mod_scripting_rhai"]
-rhai_script_api = ["bevy_script_api/rhai"]
 
 ## rune
 rune = ["bevy_mod_scripting_rune"]
@@ -66,7 +56,6 @@ bevy_mod_scripting_core = { workspace = true }
 bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", version = "0.8.0-alpha.1", optional = true }
 bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.8.0-alpha.1", optional = true }
 bevy_mod_scripting_rune = { path = "crates/languages/bevy_mod_scripting_rune", version = "0.8.0-alpha.1", optional = true }
-bevy_script_api = { path = "crates/bevy_script_api", version = "0.8.0-alpha.1", optional = true }
 
 
 [workspace.dependencies]
@@ -86,7 +75,6 @@ rhai-rand = "0.1"
 members = [
     "crates/bevy_mod_scripting_core",
     "crates/bevy_event_priority",
-    "crates/bevy_script_api",
     "crates/languages/bevy_mod_scripting_lua",
     "crates/languages/bevy_mod_scripting_lua_derive",
     "crates/languages/bevy_mod_scripting_rhai",
@@ -120,7 +108,7 @@ debug = false
 # path = "examples/lua/console_integration.rs"
 # required-features = [
 #     "lua54",
-#     "lua_script_api",
+#     
 #     "bevy/file_watcher",
 #     "bevy/multi_threaded",
 # ]
@@ -130,7 +118,7 @@ debug = false
 # path = "examples/rhai/console_integration.rs"
 # required-features = [
 #     "rhai",
-#     "rhai_script_api",
+#     ,
 #     "bevy/file_watcher",
 #     "bevy/multi_threaded",
 # ]
@@ -143,32 +131,22 @@ required-features = ["lua54"]
 [[example]]
 name = "dynamic_queries_lua"
 path = "examples/lua/dynamic_queries.rs"
-required-features = ["lua54", "lua_script_api"]
+required-features = ["lua54"]
 
 [[example]]
 name = "dynamic_queries_rhai"
 path = "examples/rhai/dynamic_queries.rs"
-required-features = ["rhai", "rhai_script_api"]
+required-features = ["rhai"]
 
 [[example]]
 name = "game_of_life_lua"
 path = "examples/lua/game_of_life.rs"
-required-features = [
-    "lua54",
-    "lua_script_api",
-    "bevy/file_watcher",
-    "bevy/multi_threaded",
-]
+required-features = ["lua54", "bevy/file_watcher", "bevy/multi_threaded"]
 
 [[example]]
+required-features = ["rhai", "bevy/file_watcher", "bevy/multi_threaded"]
 name = "game_of_life_rhai"
 path = "examples/rhai/game_of_life.rs"
-required-features = [
-    "rhai",
-    "rhai_script_api",
-    "bevy/file_watcher",
-    "bevy/multi_threaded",
-]
 
 [[example]]
 name = "event_recipients_lua"
@@ -183,22 +161,22 @@ required-features = ["lua54"]
 [[example]]
 name = "documentation_gen_lua"
 path = "examples/lua/documentation_gen.rs"
-required-features = ["lua54", "teal", "lua_script_api"]
+required-features = ["lua54", "teal"]
 
 [[example]]
 name = "bevy_api_lua"
 path = "examples/lua/bevy_api.rs"
-required-features = ["lua54", "lua_script_api"]
+required-features = ["lua54"]
 
 [[example]]
 name = "bevy_api_rhai"
 path = "examples/rhai/bevy_api.rs"
-required-features = ["rhai", "rhai_script_api"]
+required-features = ["rhai"]
 
 [[example]]
 name = "wrappers"
 path = "examples/wrappers.rs"
-required-features = ["lua54", "lua_script_api"]
+required-features = ["lua54"]
 
 [[example]]
 name = "minimal_rune"

assets/scripts/event_recipients.lua

@@ -1,4 +1,6 @@
 function on_event(id)
-    print(string.format("on_event, script_id: %d, Handling:", script_id))
-    print(string.format("\t-> id: %d", id))
+    print(string.format("on_event, script_id: %s, Handling:", script_id))
+    print(string.format("\t-> id            : %d", id))
+    print(string.format("\t-> entity        : %s", entity))
+
 end

check.sh

@@ -6,5 +6,5 @@ CURRENT_DIR=$(basename "$PWD")
 if [[ "$CURRENT_DIR" == "bevy_api_gen" ]]; then
     cargo +nightly-2024-11-05 clippy --all-targets --message-format=json 
 else
-    cargo clippy --workspace --all-targets --message-format=json --features="lua54 lua_script_api rhai rhai_script_api teal rune bevy/file_watcher bevy/multi_threaded"
+    cargo clippy --workspace --all-targets --message-format=json --features="lua54 rhai teal rune bevy/file_watcher bevy/multi_threaded"
 fi

crates/bevy_mod_scripting_core/src/commands.rs

@@ -106,10 +106,12 @@ impl<C: Context, R: Runtime> Command for CreateOrUpdateScript<C, R> {
             // If None assign new context ID, otherwise assign the old one
             // If re-loading and different from the previous one, the old one will be removed
             let current_context_id = (assigner.assign)(script.as_deref(), &self.id, &self.content, &mut contexts);
+            debug!("Context assigned: {:?}", current_context_id);
+
             let current_context_id = if let Some(id) = current_context_id {
                 id
             } else {
-                let ctxt = (builder.load)(&self.id, &self.content, &settings.context_initializers, &settings.context_pre_handling_initializers, world, runtime.runtime.as_mut().unwrap()).unwrap();
+                let ctxt = (builder.load)(&self.id, &self.content, &settings.context_initializers, &settings.context_pre_handling_initializers, world, &mut runtime.runtime).unwrap();
                 contexts.insert(ctxt)
             };
 

crates/bevy_mod_scripting_core/src/context.rs

@@ -136,7 +136,7 @@ pub struct ContextAssigner<C: Context> {
 impl<C: Context> Default for ContextAssigner<C> {
     fn default() -> Self {
         Self {
-            assign: |_, _, _, c| Some(c.allocate_id()),
+            assign: |old, _, _, _| old.map(|s| s.context_id),
             remove: |id, _, c| _ = c.remove(id),
         }
     }

crates/bevy_mod_scripting_core/src/lib.rs

@@ -34,11 +34,12 @@ pub mod prelude {
     pub use {crate::docs::*, crate::error::*, crate::event::*, crate::systems::*, crate::*};
 }
 
-#[derive(Default)]
 /// Bevy plugin enabling scripting within the bevy mod scripting framework
 pub struct ScriptingPlugin<A: Args, C: Context, R: Runtime> {
     /// Callback for initiating the runtime
-    pub runtime_builder: Option<fn() -> R>,
+    pub runtime_builder: fn() -> R,
+    /// Settings for the runtime
+    pub runtime_settings: Option<RuntimeSettings<R>>,
     /// The handler used for executing callbacks in scripts
     pub callback_handler: Option<HandlerFn<A, C, R>>,
     /// The context builder for loading contexts
@@ -47,6 +48,18 @@ pub struct ScriptingPlugin<A: Args, C: Context, R: Runtime> {
     pub context_assigner: Option<ContextAssigner<C>>,
 }
 
+impl<A: Args, C: Context, R: Runtime + Default> Default for ScriptingPlugin<A, C, R> {
+    fn default() -> Self {
+        Self {
+            runtime_builder: R::default,
+            runtime_settings: Default::default(),
+            callback_handler: Default::default(),
+            context_builder: Default::default(),
+            context_assigner: Default::default(),
+        }
+    }
+}
+
 impl<A: Args, C: Context, R: Runtime> Plugin for ScriptingPlugin<A, C, R> {
     fn build(&self, app: &mut bevy::prelude::App) {
         app.add_event::<ScriptErrorEvent>()
@@ -60,11 +73,10 @@ impl<A: Args, C: Context, R: Runtime> Plugin for ScriptingPlugin<A, C, R> {
                 extensions: &[],
                 preprocessor: None,
             })
-            // not every script host will have a runtime, for convenience we add a dummy runtime
+            .insert_resource(self.runtime_settings.as_ref().cloned().unwrap_or_default())
             .insert_non_send_resource::<RuntimeContainer<R>>(RuntimeContainer {
-                runtime: self.runtime_builder.map(|f| f()),
+                runtime: (self.runtime_builder)(),
             })
-            .init_non_send_resource::<RuntimeContainer<R>>()
             .init_non_send_resource::<ScriptContexts<C>>()
             .insert_resource::<CallbackSettings<A, C, R>>(CallbackSettings {
                 callback_handler: self.callback_handler,
@@ -86,7 +98,9 @@ pub trait AddRuntimeInitializer<R: Runtime> {
 
 impl<R: Runtime> AddRuntimeInitializer<R> for App {
     fn add_runtime_initializer(&mut self, initializer: RuntimeInitializer<R>) -> &mut Self {
-        self.world_mut().init_resource::<RuntimeSettings<R>>();
+        if !self.world_mut().contains_resource::<RuntimeSettings<R>>() {
+            self.world_mut().init_resource::<RuntimeSettings<R>>();
+        }
         self.world_mut()
             .resource_mut::<RuntimeSettings<R>>()
             .as_mut()
@@ -180,3 +194,32 @@ impl<D: DocumentationFragment> StoreDocumentation<D> for App {
         top_fragment.gen_docs()
     }
 }
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_default_scripting_plugin_initializes_all_resources_correctly() {
+        let mut app = App::new();
+        #[derive(Default, Clone)]
+        struct A;
+        #[derive(Default, Clone)]
+        struct C;
+        #[derive(Default, Clone)]
+        struct R;
+        app.add_plugins(AssetPlugin::default());
+        app.add_plugins(ScriptingPlugin::<A, C, R>::default());
+
+        assert!(app.world().contains_resource::<Scripts>());
+        assert!(app.world().contains_resource::<ReflectAllocator>());
+        assert!(app.world().contains_resource::<ScriptAssetSettings>());
+        assert!(app.world().contains_resource::<RuntimeSettings<R>>());
+        assert!(app.world().contains_resource::<CallbackSettings<A, C, R>>());
+        assert!(app
+            .world()
+            .contains_resource::<ContextLoadingSettings<C, R>>());
+        assert!(app.world().contains_non_send::<RuntimeContainer<R>>());
+        assert!(app.world().contains_non_send::<ScriptContexts<C>>());
+    }
+}

crates/bevy_mod_scripting_core/src/runtime.rs

@@ -8,7 +8,7 @@ impl<T: 'static> Runtime for T {}
 
 pub type RuntimeInitializer<R> = fn(&mut R);
 
-#[derive(Clone, Resource)]
+#[derive(Resource)]
 pub struct RuntimeSettings<R: Runtime> {
     pub initializers: Vec<RuntimeInitializer<R>>,
 }
@@ -21,16 +21,16 @@ impl<R: Runtime> Default for RuntimeSettings<R> {
     }
 }
 
-/// Stores a particular runtime.
-#[derive(Resource)]
-pub struct RuntimeContainer<R: Runtime> {
-    pub runtime: Option<R>,
-}
-
-impl<T: Runtime> Default for RuntimeContainer<T> {
-    fn default() -> Self {
+impl<R: Runtime> Clone for RuntimeSettings<R> {
+    fn clone(&self) -> Self {
         Self {
-            runtime: Default::default(),
+            initializers: self.initializers.clone(),
         }
     }
 }
+
+/// Stores a particular runtime.
+#[derive(Resource)]
+pub struct RuntimeContainer<R: Runtime> {
+    pub runtime: R,
+}