virtualx-engine/doc/classes/PhysicsTestMotionParameters2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsTestMotionParameters2D" 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 body motion test.
	</brief_description>
	<description>
		This class contains parameters used in [method PhysicsServer2D.body_test_motion].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false">
			If set to [code]true[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground.
			If set to [code]false[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes.
		</member>
		<member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]">
			Optional array of body [RID] to exclude from collision.
		</member>
		<member name="exclude_objects" type="Array" setter="set_exclude_objects" getter="get_exclude_objects" default="[]">
			Optional array of object unique instance ID to exclude from collision. See [method Object.get_instance_id].
		</member>
		<member name="from" type="Transform2D" setter="set_from" getter="get_from" default="Transform2D(1, 0, 0, 1, 0, 0)">
			Transform in global space where the motion should start. Usually set to [member Node2D.global_transform] for the current body's transform.
		</member>
		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.08">
			Increases the size of the shapes involved in the collision detection.
		</member>
		<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2(0, 0)">
			Motion vector to define the length and direction of the motion to test.
		</member>
		<member name="recovery_as_collision" type="bool" setter="set_recovery_as_collision_enabled" getter="is_recovery_as_collision_enabled" default="false">
			If set to [code]true[/code], any depenetration from the recovery phase is reported as a collision; this is used e.g. by [method CharacterBody2D.move_and_slide] for improving floor detection when floor snapping is disabled.
			If set to [code]false[/code], only collisions resulting from the motion are reported; this is used e.g. by [method PhysicsBody2D.move_and_collide].
		</member>
	</members>
</class>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead) 2021-09-30 20:28:57 +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-02-14 14:18:53 +01:00			`<class name="PhysicsTestMotionParameters2D" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead) 2021-09-30 20:28:57 +02:00			`<brief_description>`
			`Parameters to be sent to a 2D body motion test.`
			`</brief_description>`
			`<description>`
			`This class contains parameters used in [method PhysicsServer2D.body_test_motion].`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
			`<member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false">`
			`If set to [code]true[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground.`
			`If set to [code]false[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes.`
			`</member>`
			`<member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]">`
			`Optional array of body [RID] to exclude from collision.`
			`</member>`
Fix physics glitch with TileMap moving platforms Added a parameter in test_body_motion to exclude attached objects from collision, used to avoid collision with all TileMap tiles with moving platform motion instead of just the one tile the character touches. Same changes made in 3D for consistency, and handling potential similar cases. 2021-09-30 20:05:30 +02:00			`<member name="exclude_objects" type="Array" setter="set_exclude_objects" getter="get_exclude_objects" default="[]">`
			`Optional array of object unique instance ID to exclude from collision. See [method Object.get_instance_id].`
			`</member>`
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead) 2021-09-30 20:28:57 +02:00			`<member name="from" type="Transform2D" setter="set_from" getter="get_from" default="Transform2D(1, 0, 0, 1, 0, 0)">`
			`Transform in global space where the motion should start. Usually set to [member Node2D.global_transform] for the current body's transform.`
			`</member>`
			`<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.08">`
			`Increases the size of the shapes involved in the collision detection.`
			`</member>`
			`<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2(0, 0)">`
			`Motion vector to define the length and direction of the motion to test.`
			`</member>`
Add motion parameter to toggle whether recovery is reported as a collision This makes the intent explicit in each use case. 2022-04-28 22:44:09 +02:00			`<member name="recovery_as_collision" type="bool" setter="set_recovery_as_collision_enabled" getter="is_recovery_as_collision_enabled" default="false">`
			`If set to [code]true[/code], any depenetration from the recovery phase is reported as a collision; this is used e.g. by [method CharacterBody2D.move_and_slide] for improving floor detection when floor snapping is disabled.`
			`If set to [code]false[/code], only collisions resulting from the motion are reported; this is used e.g. by [method PhysicsBody2D.move_and_collide].`
			`</member>`
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead) 2021-09-30 20:28:57 +02:00			`</members>`
			`</class>`