feat!: Use the Handles, Luke! (#427) (#444)

Co-authored-by: Shane Celis <[email protected]>
Co-authored-by: Alex Parlett <[email protected]>

Author: 3 people

Cargo.toml

@@ -82,6 +82,7 @@ bevy_mod_scripting_derive = { workspace = true }
 
 [workspace.dependencies]
 profiling = { version = "1.0" }
+
 bevy = { version = "0.16.0", default-features = false }
 bevy_math = { version = "0.16.0" }
 bevy_reflect = { version = "0.16.0" }

assets/reload.lua

@@ -0,0 +1,22 @@
+-- reload.lua
+--
+-- An example of the script reload feature. Exercise with this command:
+-- ```sh
+-- cargo run --features lua54,bevy/file_watcher,bevy/multi_threaded --example run-script -- reload.lua
+-- ```
+function on_script_loaded()
+    world.info("Hello world")
+end
+
+function on_script_unloaded()
+    world.info("Goodbye world")
+    return "house"
+end
+
+function on_script_reloaded(value)
+    if value then
+        world.info("I'm back. Thanks for the "..value.." keys!")
+    else
+        world.info('I have not saved any state before unloading')
+    end
+end

assets/tests/add_system/added_systems_run_in_parallel.lua

@@ -1,34 +1,35 @@
-
 function on_test()
-    local post_update_schedule = world.get_schedule_by_name("PostUpdate")
-    
-    local test_system = post_update_schedule:get_system_by_name("on_test_post_update")
-    
-    local system_a = world.add_system(
-        post_update_schedule,
-        system_builder("custom_system_a", script_id)
-            :after(test_system)
-    )
-        
-    local system_b = world.add_system(
-        post_update_schedule,
-        system_builder("custom_system_b", script_id)
-            :after(test_system)
-    )    
+  local post_update_schedule = world.get_schedule_by_name("PostUpdate")
+
+  local test_system = post_update_schedule:get_system_by_name("on_test_post_update")
+
+  local script_attachment = ScriptAttachment.new_entity_script(entity, script_asset)
 
-    -- generate a schedule graph and verify it's what we expect
-    local dot_graph = post_update_schedule:render_dot()
+  local system_a = world.add_system(
+    post_update_schedule,
+    system_builder("custom_system_a", script_attachment)
+    :after(test_system)
+  )
 
-    local expected_dot_graph = [[
+  local system_b = world.add_system(
+    post_update_schedule,
+    system_builder("custom_system_b", script_attachment)
+    :after(test_system)
+  )
+
+  -- generate a schedule graph and verify it's what we expect
+  local dot_graph = post_update_schedule:render_dot()
+
+  local expected_dot_graph = [[
 digraph {
   node_0 [label="bevy_asset::assets::Assets<bevy_asset::folder::LoadedFolder>::asset_events"];
   node_1 [label="bevy_asset::assets::Assets<bevy_asset::assets::LoadedUntypedAsset>::asset_events"];
   node_2 [label="bevy_asset::assets::Assets<()>::asset_events"];
   node_3 [label="bevy_asset::assets::Assets<bevy_mod_scripting_core::asset::ScriptAsset>::asset_events"];
   node_4 [label="bevy_mod_scripting_core::bindings::allocator::garbage_collector"];
-  node_5 [label="on_test_post_update"];
-  node_6 [label="script_integration_test_harness::dummy_before_post_update_system"];
-  node_7 [label="script_integration_test_harness::dummy_post_update_system"];
+  node_5 [label="script_integration_test_harness::dummy_before_post_update_system"];
+  node_6 [label="script_integration_test_harness::dummy_post_update_system"];
+  node_7 [label="on_test_post_update"];
   node_8 [label="custom_system_a"];
   node_9 [label="custom_system_b"];
   node_10 [label="SystemSet AssetEvents"];
@@ -42,11 +43,10 @@ digraph {
   node_4 -> node_11 [color=red, label="child of", arrowhead=diamond];
   node_8 -> node_12 [color=red, label="child of", arrowhead=diamond];
   node_9 -> node_13 [color=red, label="child of", arrowhead=diamond];
-  node_5 -> node_8 [color=blue, label="runs before", arrowhead=normal];
-  node_5 -> node_9 [color=blue, label="runs before", arrowhead=normal];
-  node_6 -> node_7 [color=blue, label="runs before", arrowhead=normal];
+  node_5 -> node_6 [color=blue, label="runs before", arrowhead=normal];
+  node_7 -> node_8 [color=blue, label="runs before", arrowhead=normal];
+  node_7 -> node_9 [color=blue, label="runs before", arrowhead=normal];
 }
     ]]
-
-    assert_str_eq(dot_graph, expected_dot_graph, "Expected the schedule graph to match the expected graph")
+  assert_str_eq(dot_graph, expected_dot_graph, "Expected the schedule graph to match the expected graph")
 end

assets/tests/add_system/added_systems_run_in_parallel.rhai

@@ -1,17 +1,18 @@
 fn on_test() {
     let post_update_schedule = world.get_schedule_by_name.call("PostUpdate");
 
+    let script_attachment = ScriptAttachment.new_entity_script.call(entity, script_asset);
     let test_system = post_update_schedule.get_system_by_name.call("on_test_post_update");
 
     let system_a = world.add_system.call(
         post_update_schedule,
-        system_builder.call("custom_system_a", script_id)
+        system_builder.call("custom_system_a", script_attachment)
             .after.call(test_system)
     );
 
     let system_b = world.add_system.call(
         post_update_schedule,
-        system_builder.call("custom_system_b", script_id)
+        system_builder.call("custom_system_b", script_attachment)
             .after.call(test_system)
     );
 
@@ -25,9 +26,9 @@ digraph {
   node_2 [label="bevy_asset::assets::Assets<()>::asset_events"];
   node_3 [label="bevy_asset::assets::Assets<bevy_mod_scripting_core::asset::ScriptAsset>::asset_events"];
   node_4 [label="bevy_mod_scripting_core::bindings::allocator::garbage_collector"];
-  node_5 [label="on_test_post_update"];
-  node_6 [label="script_integration_test_harness::dummy_before_post_update_system"];
-  node_7 [label="script_integration_test_harness::dummy_post_update_system"];
+  node_5 [label="script_integration_test_harness::dummy_before_post_update_system"];
+  node_6 [label="script_integration_test_harness::dummy_post_update_system"];
+  node_7 [label="on_test_post_update"];
   node_8 [label="custom_system_a"];
   node_9 [label="custom_system_b"];
   node_10 [label="SystemSet AssetEvents"];
@@ -41,9 +42,9 @@ digraph {
   node_4 -> node_11 [color=red, label="child of", arrowhead=diamond];
   node_8 -> node_12 [color=red, label="child of", arrowhead=diamond];
   node_9 -> node_13 [color=red, label="child of", arrowhead=diamond];
-  node_5 -> node_8 [color=blue, label="runs before", arrowhead=normal];
-  node_5 -> node_9 [color=blue, label="runs before", arrowhead=normal];
-  node_6 -> node_7 [color=blue, label="runs before", arrowhead=normal];
+  node_5 -> node_6 [color=blue, label="runs before", arrowhead=normal];
+  node_7 -> node_8 [color=blue, label="runs before", arrowhead=normal];
+  node_7 -> node_9 [color=blue, label="runs before", arrowhead=normal];
 }`; 
 
     assert_str_eq.call(dot_graph, expected_dot_graph, "Expected the schedule graph to match the expected graph");

assets/tests/add_system/adds_system_in_correct_order.lua

@@ -1,41 +1,41 @@
 -- add two systems, one before and one after the existing `on_test_post_update` callback, then assert all systems have run
 -- in the `on_test_last` callback
 
-local runs = {}    
+local runs = {}
 
 -- runs on `Update`
 function on_test()
     local post_update_schedule = world.get_schedule_by_name("PostUpdate")
-    
+
     local test_system = post_update_schedule:get_system_by_name("on_test_post_update")
-    
+    local script_attachment = ScriptAttachment.new_entity_script(entity, script_asset)
+
     local system_after = world.add_system(
         post_update_schedule,
-        system_builder("custom_system_after", script_id)
-            :after(test_system)
+        system_builder("custom_system_after", script_attachment)
+        :after(test_system)
     )
-        
+
     local system_before = world.add_system(
         post_update_schedule,
-        system_builder("custom_system_before", script_id)
-            :before(test_system)
-    )    
+        system_builder("custom_system_before", script_attachment)
+        :before(test_system)
+    )
 
     local script_system_between = world.add_system(
         post_update_schedule,
-        system_builder("custom_system_between", script_id)
-            :after(test_system)
-            :before(system_after)
+        system_builder("custom_system_between", script_attachment)
+        :after(test_system)
+        :before(system_after)
     )
 end
 
-
 function custom_system_before()
     print("custom_system_before")
     runs[#runs + 1] = "custom_system_before"
 end
 
--- runs on post_update 
+-- runs on post_update
 function on_test_post_update()
     print("on_test_post_update")
     runs[#runs + 1] = "on_test_post_update"
@@ -53,9 +53,10 @@ end
 
 -- runs in the `Last` bevy schedule
 function on_test_last()
-    assert(#runs == 4, "Expected 4 runs, got: " .. #runs)
+    local string_table = table.concat(runs, ", ")
+    assert(#runs == 4, "Expected 4 runs, got: " .. tostring(string_table))
     assert(runs[1] == "custom_system_before", "Expected custom_system_before to run first, got: " .. runs[1])
     assert(runs[2] == "on_test_post_update", "Expected on_test_post_update to run second, got: " .. runs[2])
     assert(runs[3] == "custom_system_between", "Expected custom_system_between to run third, got: " .. runs[3])
     assert(runs[4] == "custom_system_after", "Expected custom_system_after to run second, got: " .. runs[4])
-end
+end

assets/tests/add_system/adds_system_in_correct_order.rhai

@@ -3,16 +3,17 @@ let runs = [];
 fn on_test() {
     let post_update_schedule = world.get_schedule_by_name.call("PostUpdate");
     let test_system = post_update_schedule.get_system_by_name.call("on_test_post_update");
+    let script_attachment = ScriptAttachment.new_entity_script.call(entity, script_asset);
 
-    let builder_after = system_builder.call("custom_system_after", script_id)
+    let builder_after = system_builder.call("custom_system_after", script_attachment)
         .after.call(test_system);
     let system_after = world.add_system.call(post_update_schedule, builder_after);
 
-    let builder_before = system_builder.call("custom_system_before", script_id)
+    let builder_before = system_builder.call("custom_system_before", script_attachment)
         .before.call(test_system);
     let system_before = world.add_system.call(post_update_schedule, builder_before);
 
-    let builder_between = system_builder.call("custom_system_between", script_id)
+    let builder_between = system_builder.call("custom_system_between", script_attachment)
         .after.call(test_system)
         .before.call(system_after);
 

assets/tests/add_system/system_can_access_unspecified_resource_in_exclusive_system__RETURNS.lua renamed to assets/tests/add_system/system_can_access_unspecified_resource_in_exclusive_system.lua

@@ -1,12 +1,11 @@
-
 runs = {}
 
 function on_test()
     local post_update_schedule = world.get_schedule_by_name("PostUpdate")
-    
+    local script_attachment = ScriptAttachment.new_entity_script(entity, script_asset)
     world.add_system(
         post_update_schedule,
-        system_builder("my_exclusive_system", script_id):exclusive()
+        system_builder("my_exclusive_system", script_attachment):exclusive()
     )
 
     return true
@@ -21,12 +20,11 @@ function my_exclusive_system()
     assert(res ~= nil, "Expected to get resource but got nil")
 end
 
-
 function on_test_post_update()
     return true
 end
 
 function on_test_last()
     assert(#runs == 1, "Expected 1 runs, got: " .. #runs)
     return true
-end
+end

assets/tests/add_system/system_can_access_unspecified_resource_in_exclusive_system__RETURNS.rhai renamed to assets/tests/add_system/system_can_access_unspecified_resource_in_exclusive_system.rhai

@@ -2,10 +2,11 @@ let runs = [];
 
 fn on_test() {
     let post_update_schedule = world.get_schedule_by_name.call("PostUpdate");
-    
+    let script_attachment = ScriptAttachment.new_entity_script.call(entity, script_asset);
+   
     world.add_system.call(
         post_update_schedule,
-        system_builder.call("my_exclusive_system", script_id).exclusive.call()
+        system_builder.call("my_exclusive_system", script_attachment).exclusive.call()
     );
 
     return true;

assets/tests/add_system/system_cannot_access_unspecified_resource_in_non_exclusive_system__RETURNS.lua renamed to assets/tests/add_system/system_cannot_access_unspecified_resource_in_non_exclusive_system.lua

@@ -1,12 +1,12 @@
-
 runs = {}
 
 function on_test()
     local post_update_schedule = world.get_schedule_by_name("PostUpdate")
-    
+    local script_attachment = ScriptAttachment.new_entity_script(entity, script_asset)
+
     world.add_system(
         post_update_schedule,
-        system_builder("my_non_exclusive_system", script_id)
+        system_builder("my_non_exclusive_system", script_attachment)
     )
 
     return true
@@ -23,12 +23,11 @@ function my_non_exclusive_system()
     end, ".*annot claim access to.*")
 end
 
-
 function on_test_post_update()
     return true
 end
 
 function on_test_last()
     assert(#runs == 1, "Expected 1 runs, got: " .. #runs)
     return true
-end
+end

assets/tests/add_system/system_cannot_access_unspecified_resource_in_non_exclusive_system__RETURNS.rhai renamed to assets/tests/add_system/system_cannot_access_unspecified_resource_in_non_exclusive_system.rhai

@@ -2,7 +2,8 @@ let runs = [];
 
 fn on_test() {
     let post_update_schedule = world.get_schedule_by_name.call("PostUpdate");
-    world.add_system.call(post_update_schedule, system_builder.call("my_non_exclusive_system", script_id));
+    let script_attachment = ScriptAttachment.new_entity_script.call(entity, script_asset);
+    world.add_system.call(post_update_schedule, system_builder.call("my_non_exclusive_system", script_attachment));
     return true;
 }