virtualx-engine/doc/classes/PhysicsRayQueryParameters2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsRayQueryParameters2D" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Parameters to be sent to a 2D ray physics query.
	</brief_description>
	<description>
		This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState2D.intersect_ray].
	</description>
	<tutorials>
	</tutorials>
	<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_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">
			The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. 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="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)">
			The starting point of the ray being queried for, in global coordinates.
		</member>
		<member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false">
			If [code]true[/code], the query will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector2(0, 0)[/code]. Does not affect concave polygon shapes.
		</member>
		<member name="to" type="Vector2" setter="set_to" getter="get_to" default="Vector2(0, 0)">
			The ending point of the ray being queried for, in global coordinates.
		</member>
	</members>
</class>
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter. 2021-11-02 02:00:58 +01: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-02-14 14:18:53 +01:00			`<class name="PhysicsRayQueryParameters2D" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter. 2021-11-02 02:00:58 +01:00			`<brief_description>`
			`Parameters to be sent to a 2D ray physics query.`
			`</brief_description>`
			`<description>`
			`This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState2D.intersect_ray].`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<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_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.`
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter. 2021-11-02 02:00:58 +01:00			`</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="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)">`
			`The starting point of the ray being queried for, in global coordinates.`
			`</member>`
Add raycast options to hit when starting inside / hit back faces Makes the results consistent for all shape types with options to set the desired behavior. 2021-11-10 23:57:11 +01:00			`<member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false">`
			`If [code]true[/code], the query will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector2(0, 0)[/code]. Does not affect concave polygon shapes.`
			`</member>`
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter. 2021-11-02 02:00:58 +01:00			`<member name="to" type="Vector2" setter="set_to" getter="get_to" default="Vector2(0, 0)">`
			`The ending point of the ray being queried for, in global coordinates.`
			`</member>`
			`</members>`
			`</class>`