virtualx-engine/doc/classes/Physics2DShapeQueryParameters.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DShapeQueryParameters" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Parameters to be sent to a 2D shape physics query.
	</brief_description>
	<description>
		This class contains the shape and other parameters for 2D intersection/collision queries.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="set_shape">
			<return type="void" />
			<argument index="0" name="shape" type="Resource" />
			<description>
				Sets the [Shape2D] that will be used for collision/intersection queries.
			</description>
		</method>
	</methods>
	<members>
		<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
			If [code]true[/code], the query will take [Area2D]s into account.
		</member>
		<member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">
			If [code]true[/code], the query will take [PhysicsBody2D]s into account.
		</member>
		<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="2147483647">
			The physics layer(s) the query will take into account (as a bitmask). See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
		</member>
		<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[  ]">
			The list of objects or object [RID]s that will be excluded from collisions.
		</member>
		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
			The collision margin for the shape.
		</member>
		<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2( 0, 0 )">
			The motion of the shape being queried for.
		</member>
		<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
			The queried shape's [RID]. See also [method set_shape].
		</member>
		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
			The queried shape's transform matrix.
		</member>
	</members>
	<constants>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-03-16 23:01:02 +01:00			`<class name="Physics2DShapeQueryParameters" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Parameters to be sent to a 2D shape physics query.`
			`</brief_description>`
			`<description>`
Remove unused PhysicsShapeQueryResult & Physics2DShapeQueryResult 2021-07-03 01:45:36 +02:00			`This class contains the shape and other parameters for 2D intersection/collision queries.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="set_shape">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="void" />`
			`<argument index="0" name="shape" type="Resource" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`Sets the [Shape2D] that will be used for collision/intersection queries.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</method>`
			`</methods>`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">`
Improve the Shape/Shape2D classes documentation 2019-12-09 15:16:28 +01:00			`If [code]true[/code], the query will take [Area2D]s into account.`
doc: Sync classref with current source 2018-08-29 22:25:11 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">`
Improve the Shape/Shape2D classes documentation 2019-12-09 15:16:28 +01:00			`If [code]true[/code], the query will take [PhysicsBody2D]s into account.`
doc: Sync classref with current source 2018-08-29 22:25:11 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="2147483647">`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:11:20 +01:00			`The physics layer(s) the query will take into account (as a bitmask). See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[ ]">`
Improve the Shape/Shape2D classes documentation 2019-12-09 15:16:28 +01:00			`The list of objects or object [RID]s that will be excluded from collisions.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`The collision margin for the shape.`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2( 0, 0 )">`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`The motion of the shape being queried for.`
			`</member>`
			`<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">`
Improve the Shape/Shape2D classes documentation 2019-12-09 15:16:28 +01:00			`The queried shape's [RID]. See also [method set_shape].`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, 1, 0, 0 )">`
Improve the Shape/Shape2D classes documentation 2019-12-09 15:16:28 +01:00			`The queried shape's transform matrix.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
			`</members>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<constants>`
			`</constants>`
			`</class>`