change query signature slightly

Author: makspll

assets/scripts/game_of_life.lua

@@ -6,14 +6,9 @@ world.info("Lua: The game_of_life.lua script just got loaded")
 math.randomseed(os.time())
 
 function fetch_life_state() 
-    -- find the entity with life state 
-    local life_state = nil
-
-    for i,result in pairs(world.query({LifeState}):build()) do 
-        life_state = result:components()[1]
-        break
-    end 
-    return life_state
+    -- find the first entity with life state 
+    local i,v = next(world.query():component(LifeState):build())
+    return v:components()[1]
 end  
 
 function on_script_loaded()
@@ -53,7 +48,28 @@ function on_click(x,y)
     local cell_y = math.floor(y / cell_height)
 
     local index = (cell_y * dimension_x) + cell_x
-    cells[index] = 255
+
+    -- toggle a bunch of cells around if they exist
+    local cell_offsets = {
+        {0,0},
+        {1,0},
+        {0,1},
+        {1,1},
+        {-1,0},
+        {0,-1},
+        {-1,-1},
+        {1,-1},
+        {-1,1}
+    }
+
+    for _,offset in pairs(cell_offsets) do 
+        local offset_x = offset[1]
+        local offset_y = offset[2]
+        local new_index = index + offset_x + offset_y * dimension_x
+        if new_index > 0 and new_index <= (dimension_x * dimension_y) then
+            cells[new_index] = 255
+        end
+    end
 end
 
 function on_update()

crates/bevy_mod_scripting_core/src/bindings/query.rs

@@ -90,16 +90,30 @@ impl ScriptQueryBuilder {
         self.components.extend(components);
         self
     }
+    pub fn component(&mut self, component: ScriptTypeRegistration) -> &mut Self {
+        self.components.push(component);
+        self
+    }
 
-    pub fn with(&mut self, with: Vec<ScriptTypeRegistration>) -> &mut Self {
+    pub fn with_components(&mut self, with: Vec<ScriptTypeRegistration>) -> &mut Self {
         self.with.extend(with);
         self
     }
 
-    pub fn without(&mut self, without: Vec<ScriptTypeRegistration>) -> &mut Self {
+    pub fn with_component(&mut self, with: ScriptTypeRegistration) -> &mut Self {
+        self.with.push(with);
+        self
+    }
+
+    pub fn without_components(&mut self, without: Vec<ScriptTypeRegistration>) -> &mut Self {
         self.without.extend(without);
         self
     }
+
+    pub fn without_component(&mut self, without: ScriptTypeRegistration) -> &mut Self {
+        self.without.push(without);
+        self
+    }
 }
 
 #[derive(Clone, Reflect)]

crates/bevy_mod_scripting_functions/src/core.rs

@@ -138,9 +138,8 @@ pub fn register_world_functions(reg: &mut World) -> Result<(), FunctionRegistrat
         })
         .register(
             "query",
-            |components: Vec<Val<ScriptTypeRegistration>>| {
-                let mut query_builder = ScriptQueryBuilder::default();
-                query_builder.components(components.into_iter().map(|v| v.into_inner()).collect());
+            || {
+                let query_builder = ScriptQueryBuilder::default();
                 Ok(Val(query_builder))
             },
         )
@@ -363,19 +362,24 @@ pub fn register_script_query_builder_functions(
     registry: &mut World,
 ) -> Result<(), FunctionRegistrationError> {
     NamespaceBuilder::<ScriptQueryBuilder>::new(registry)
+        .register("component", |s: Val<ScriptQueryBuilder>, components: Val<ScriptTypeRegistration>| {
+            let mut builder = s.into_inner();
+            builder.component(components.into_inner());
+            Val(builder)
+        })
         .register(
             "with",
             |s: Val<ScriptQueryBuilder>, with: Val<ScriptTypeRegistration>| {
                 let mut builder = s.into_inner();
-                builder.with(vec![with.into_inner()]);
+                builder.with_component(with.into_inner());
                 Val(builder)
             },
         )
         .register(
             "without",
             |s: Val<ScriptQueryBuilder>, without: Val<ScriptTypeRegistration>| {
                 let mut builder = s.into_inner();
-                builder.without(vec![without.into_inner()]);
+                builder.without_component(without.into_inner());
                 Val(builder)
             },
         )

crates/languages/bevy_mod_scripting_lua/tests/data/query/empty_query_returns_nothing.lua

@@ -1,5 +1,5 @@
 local component_a = world.get_type_by_name("TestComponent")
 
-for i,result in pairs(world.query({component_a}):with(component_a):without(component_a):build()) do
+for i,result in pairs(world.query():component(component_a):without(component_a):build()) do
     assert(false, "This should not be reached")
 end

crates/languages/bevy_mod_scripting_lua/tests/data/query/query_returns_all_entities_matching.lua

@@ -13,7 +13,7 @@ world.add_default_component(entity_c, component_with)
 world.add_default_component(entity_b, component_without)
 
 local found_entities = {}
-for i,result in pairs(world.query({component_with}):with(component_with):without(component_without):build()) do
+for i,result in pairs(world.query():component(component_with):without(component_without):build()) do
     table.insert(found_entities, result:entity())
 end
 

docs/src/ScriptingReference/script-query-builder.md

@@ -2,6 +2,27 @@
 
 The query builder is used to build queries for entities with specific components. Can be used to interact with arbitrary entities in the world.
 
+## component
+
+Adds a component to the query, this will be accessible in the query results under the index corresponding to the index of this component in the query.
+
+Arguments:
+
+| Argument | Type | Description |
+| --- | --- | --- |
+| `s` | `ScriptQueryBuilder` | The query builder |
+| `component` | `ScriptTypeRegistration` | The component to query for |
+
+Returns:
+
+| Return | Description |
+| ---  | --- |
+| `ScriptQueryBuilder` | The updated query builder |
+
+```lua
+query:component(MyType):component(MyOtherType)
+```
+
 ## with
 
 Arguments:

docs/src/ScriptingReference/world.md

@@ -284,20 +284,14 @@ end
 
 ### query
 
-Arguments:
-
-| Argument | Type | Description |
-| --- | --- | --- |
-| `components` | `Vec<ScriptTypeRegistration>` | The components to query for |
-
 Returns:
 
 | Return | Description |
 | ---  | --- |
 | `ScriptQueryBuilder` | The query builder |
 
 ```lua
-query = world.query({MyType})
+local queryBuilder = world.query()
 ```
 
 ### exit