Merge pull request #96 from GsLogiMaker:feature/add-entity-clear-method

GsLogiMaker · web-flow · commit b5598d8b1383 · 2025-02-10T15:20:38.000-06:00
Add `GFEntity.clear` method
diff --git a/cpp/src/doc_classes/GFComponent.xml b/cpp/src/doc_classes/GFComponent.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFComponent" inherits="GFRegisterableEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFComponent" inherits="GFRegisterableEntity"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to a Glecs component from a [GFWorld] that is attatached to an entity.
 	</brief_description>
@@ -76,6 +77,12 @@
 				Overrides [method GFEntity.addv].
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFComponent" />
+			<description>
+				Overrides [method GFEntity.clear].
+			</description>
+		</method>
 		<method name="emit">
 			<return type="GFComponent" />
 			<param index="0" name="entity" type="Variant" />
diff --git a/cpp/src/doc_classes/GFEntity.xml b/cpp/src/doc_classes/GFEntity.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFEntity" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFEntity" inherits="RefCounted"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to an entity from a [GFWorld].
 	</brief_description>
@@ -114,6 +115,24 @@
 				This method returns [code]self[/code] for chaining.
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFEntity" />
+			<description>
+				Removes all added entities, pairs, and components.
+				[codeblock]
+				var fruit:= GFEntity.new()
+				var edible:= GFEntity.new()
+				var apple:= GFEntity.new()
+				apple.add(fruit)
+				apple.add(edible)
+
+				apple.has(fruit) and apple.has(edible) # true
+				apple.clear()
+				apple.has(fruit) or apple.has(edible) # false
+				[/codeblock]
+				This method returns [code]self[/code] for chaining.
+			</description>
+		</method>
 		<method name="delete" qualifiers="const">
 			<return type="void" />
 			<description>
@@ -251,6 +270,13 @@
 				[/codeblock]
 			</description>
 		</method>
+		<method name="get_target_for" qualifiers="const">
+			<return type="GFEntity" />
+			<param index="0" name="relationship" type="Variant" />
+			<param index="1" name="index" type="int" default="0" />
+			<description>
+			</description>
+		</method>
 		<method name="get_world" qualifiers="const">
 			<return type="GFWorld" />
 			<description>
@@ -333,6 +359,12 @@
 				See [method inherit].
 			</description>
 		</method>
+		<method name="is_owner_of" qualifiers="const">
+			<return type="bool" />
+			<param index="0" name="_unnamed_arg0" type="Variant" />
+			<description>
+			</description>
+		</method>
 		<method name="is_pair" qualifiers="const">
 			<return type="bool" />
 			<description>
diff --git a/cpp/src/doc_classes/GFModule.xml b/cpp/src/doc_classes/GFModule.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFModule" inherits="GFRegisterableEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFModule" inherits="GFRegisterableEntity"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -60,6 +61,12 @@
 				Overrides [method GFEntity.addv].
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFModule" />
+			<description>
+				Overrides [method GFEntity.clear].
+			</description>
+		</method>
 		<method name="emit">
 			<return type="GFModule" />
 			<param index="0" name="entity" type="Variant" />
diff --git a/cpp/src/doc_classes/GFPair.xml b/cpp/src/doc_classes/GFPair.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFPair" inherits="GFEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFPair" inherits="GFEntity"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to a pair of entity IDs.
 	</brief_description>
@@ -62,6 +63,12 @@
 				Overrides [method GFEntity.addv].
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFPair" />
+			<description>
+				Overrides [method GFEntity.clear].
+			</description>
+		</method>
 		<method name="emit">
 			<return type="GFPair" />
 			<param index="0" name="entity" type="Variant" />
diff --git a/cpp/src/doc_classes/GFRegisterableEntity.xml b/cpp/src/doc_classes/GFRegisterableEntity.xml
@@ -67,6 +67,11 @@
 			<description>
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFRegisterableEntity" />
+			<description>
+			</description>
+		</method>
 		<method name="emit">
 			<return type="GFRegisterableEntity" />
 			<param index="0" name="entity" type="Variant" />
diff --git a/cpp/src/doc_classes/GFTag.xml b/cpp/src/doc_classes/GFTag.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFTag" inherits="GFRegisterableEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFTag" inherits="GFRegisterableEntity"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to an entity with no data.
 	</brief_description>
@@ -63,6 +64,12 @@
 				Overrides [method GFEntity.addv].
 			</description>
 		</method>
+		<method name="clear">
+			<return type="GFTag" />
+			<description>
+				Overrides [method GFEntity.clear].
+			</description>
+		</method>
 		<method name="emit">
 			<return type="GFTag" />
 			<param index="0" name="entity" type="Variant" />
diff --git a/cpp/src/entity.cpp b/cpp/src/entity.cpp
@@ -394,6 +394,11 @@ Ref<GFEntity> GFEntity::set_pairv (
 	return Ref(this);
 }
 
+Ref<GFEntity> GFEntity::clear() {
+	ecs_clear(get_world()->raw(), get_id());
+	return this;
+}
+
 void GFEntity::delete_() const {
 	ecs_delete(get_world()->raw(), get_id());
 }
diff --git a/cpp/src/entity.h b/cpp/src/entity.h
@@ -18,6 +18,7 @@
 	Ref<Self> add_child(const Variant v0)	{ return GFEntity::add_child(v0); }	\
 	Ref<Self> add_sibling(const Variant v0)	{ return GFEntity::add_sibling(v0); }	\
 	Ref<Self> add_componentv(const Variant v0, const Variant v1)	{ return GFEntity::add_componentv(v0, v1); }	\
+	Ref<Self> clear()	{ return GFEntity::clear(); }	\
 	Ref<Self> set_componentv(const Variant v0, const Variant v1)	{ return GFEntity::set_componentv(v0, v1); }	\
 	Ref<Self> set_pairv(const Variant v0, const Variant v1, const Variant v2)	{ return GFEntity::set_pairv(v0, v1, v2); }	\
 	Ref<Self> add_pairv(const Variant v0, const Variant v1, const Variant v2)	{ return GFEntity::add_pairv(v0, v1, v2); }	\
@@ -36,6 +37,7 @@
 	godot::ClassDB::bind_method(D_METHOD("add_child", "entity"),	&Self::add_child);	\
 	godot::ClassDB::bind_method(D_METHOD("add_sibling", "entity"),	&Self::add_sibling);	\
 	godot::ClassDB::bind_method(D_METHOD("addv", "component", "members"),	&Self::add_componentv, Array());	\
+	godot::ClassDB::bind_method(D_METHOD("clear"),	&Self::clear);	\
 	godot::ClassDB::bind_method(D_METHOD("setv", "component", "members"),	&Self::set_componentv);	\
 	godot::ClassDB::bind_method(D_METHOD("add_pairv", "first", "second", "members"),	&Self::add_pairv, Array());	\
 	godot::ClassDB::bind_method(D_METHOD("set_pairv", "first", "second", "members"),	&Self::set_pairv);	\
@@ -130,6 +132,7 @@ namespace godot {
 		Ref<GFEntity> set_name(const String);
 		Ref<GFEntity> set_parent(const Variant entity);
 
+		Ref<GFEntity> clear();
 		void delete_() const;
 
 		Ref<GFEntity> get_child(const String) const;
diff --git a/unittests/test_entities.gd b/unittests/test_entities.gd
@@ -364,6 +364,19 @@ func test_is_owner_of():
 	assert_true(voyager.has(pos), "Expected voyager to have pos")
 	assert_true(voyager.has(rot), "Expected voyager to have rot")
 
+func test_clear():
+	var tag:= GFEntity.new_in_world(world).set_name("tag")
+	
+	var e:= GFEntity.new_in_world(world) \
+		.set_name("Entity") \
+		.add(tag)
+	
+	assert_true(e.has(tag))
+	
+	e.clear()
+
+	assert_false(e.has(tag))
+
 #endregion
 
 #region Classes

Original file line number	Diff line number	Diff line change
`@@ -394,6 +394,11 @@ Ref<GFEntity> GFEntity::set_pairv (`
`394`	`394`	`return Ref(this);`
`395`	`395`	`}`
`396`	`396`
	`397`	`+Ref<GFEntity> GFEntity::clear() {`
	`398`	`+ ecs_clear(get_world()->raw(), get_id());`
	`399`	`+ return this;`
	`400`	`+}`
	`401`	`+`
`397`	`402`	`void GFEntity::delete_() const {`
`398`	`403`	`ecs_delete(get_world()->raw(), get_id());`
`399`	`404`	`}`