feat: ✨ Dynamic Script Components, register_new_component binding, remove_component no longer requires ReflectComponent data (#379)

# Summary
In order to support dynamic script components we need:
- to relax some requirements on having a `ReflectComponent` registration
to allow component operations
- add a script component registry, which stores metadata about each
dynamically registered component
- Add `ScriptValue` to `into_script_ref` and `from_script_ref`
implementations to allow any value to be inserted into the components
payload

The nice thing about this implementation is it *just* works with the
reference system.

The current problems are that the global type cache will not reflect
this script component, to fix that we'd need a mechanism for
"re-computing" certain globals for scripts. This also does not allow
setting a schema on these, which is handy but also footgunny

As a side effect I've also made `remove_component` no longer require the
`ReflectComponent` registration

Author: makspll

.github/workflows/mdbook.yml

@@ -9,13 +9,15 @@ on:
       - 'docs/**'
       - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
+      - 'crates/bevy_mod_scripting_functions/**'
   pull_request:
     branches:
       - "**"
     paths:
       - 'docs/**'
       - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
+      - 'crates/bevy_mod_scripting_functions/**'
 
 jobs:
 

assets/tests/has_component/dynamic_component.lua

@@ -0,0 +1,6 @@
+local NewComponent = world.register_new_component("ScriptComponentA")
+local entity = world.spawn()
+
+assert(world.has_component(entity, NewComponent) == false, "Entity should not have component")
+world.add_default_component(entity, NewComponent)
+assert(world.has_component(entity, NewComponent) == true, "Entity should have component")

assets/tests/has_component/dynamic_component.rhai

@@ -0,0 +1,6 @@
+let NewComponent = world.register_new_component.call("ScriptComponentA");
+let entity = world.spawn_.call();
+
+assert(world.has_component.call(entity, NewComponent) == false, "Entity should not have component");
+world.add_default_component.call(entity, NewComponent);
+assert(world.has_component.call(entity, NewComponent) == true, "Entity should have component");

assets/tests/register_new_component/new_component_can_be_retrieved.lua

@@ -0,0 +1,12 @@
+local NewComponent = world.register_new_component("ScriptComponentA")
+assert(NewComponent ~= nil, "Failed to register new component")
+assert(NewComponent:short_name() == "DynamicComponent", "Unexpected component type")
+
+
+local new_entity = world.spawn()
+
+world.add_default_component(new_entity, NewComponent)
+
+local component_intance = world.get_component(new_entity, NewComponent)
+
+assert(component_intance ~= nil, "Failed to get component instance")

assets/tests/register_new_component/new_component_can_be_set.lua

@@ -0,0 +1,17 @@
+function on_test()
+    local NewComponent = world.register_new_component("ScriptComponentA")
+
+    local new_entity = world.spawn()
+    world.insert_component(new_entity, NewComponent, construct(types.DynamicComponent, {
+        data = "Hello World"
+    }))
+
+    local component_instance = world.get_component(new_entity, NewComponent)
+    assert(component_instance.data == "Hello World", "unexpected value: " .. component_instance.data)
+
+    component_instance.data = {
+        foo = "bar"
+    }
+
+    assert(component_instance.data.foo == "bar", "unexpected value: " .. component_instance.data.foo)
+end

assets/tests/remove_component/can_remove_dynamic_component.lua

@@ -0,0 +1,11 @@
+local NewComponent = world.register_new_component("ScriptComponentA")
+local new_entity = world.spawn()
+world.add_default_component(new_entity, NewComponent)
+
+local component_instance = world.get_component(new_entity, NewComponent)
+assert(component_instance ~= nil, "unexpected value: " .. tostring(component_instance.data))
+
+world.remove_component(new_entity, NewComponent)
+local component_instance = world.get_component(new_entity, NewComponent)
+
+assert(component_instance == nil, "unexpected value: " .. tostring(component_instance))

assets/tests/remove_component/can_remove_dynamic_component.rhai

@@ -0,0 +1,11 @@
+let NewComponent = world.register_new_component.call("ScriptComponentA");
+let new_entity = world.spawn_.call();
+world.add_default_component.call(new_entity, NewComponent);
+
+let component_instance = world.get_component.call(new_entity, NewComponent);
+assert(type_of(component_instance) != "()", "unexpected value: " + component_instance.data);
+
+world.remove_component.call(new_entity, NewComponent);
+let component_instance_after = world.get_component.call(new_entity, NewComponent);
+
+assert(type_of(component_instance_after) == "()", "unexpected value: " + component_instance_after);

assets/tests/remove_component/no_component_data.lua

@@ -0,0 +1,5 @@
+
+local entity = world._get_entity_with_test_component("CompWithDefault")
+local component = world.get_type_by_name("CompWithDefault")
+world.remove_component(entity, component)
+assert(world.has_component(entity, component) == false, "Component was not removed")

assets/tests/remove_component/no_component_data_errors.rhai renamed to assets/tests/remove_component/no_component_data.rhai

@@ -2,6 +2,5 @@
 let entity = world._get_entity_with_test_component.call("CompWithDefault");
 let component = world.get_type_by_name.call("CompWithDefault");
 
-assert_throws(||{
-    world.remove_component.call(entity, component);
-}, "Missing type data ReflectComponent for type: .*CompWithDefault.*")
+world.remove_component.call(entity, component);
+assert(world.has_component.call(entity, component) == false, "Component was not removed");