virtualx-engine/doc/classes/PhysicsTestMotionResult2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsTestMotionResult2D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Describes the motion and collision result from [method PhysicsServer2D.body_test_motion].
	</brief_description>
	<description>
		Describes the motion and collision result from [method PhysicsServer2D.body_test_motion].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_collider" qualifiers="const">
			<return type="Object" />
			<description>
				Returns the colliding body's attached [Object], if a collision occurred.
			</description>
		</method>
		<method name="get_collider_id" qualifiers="const">
			<return type="int" />
			<description>
				Returns the unique instance ID of the colliding body's attached [Object], if a collision occurred. See [method Object.get_instance_id].
			</description>
		</method>
		<method name="get_collider_rid" qualifiers="const">
			<return type="RID" />
			<description>
				Returns the colliding body's [RID] used by the [PhysicsServer2D], if a collision occurred.
			</description>
		</method>
		<method name="get_collider_shape" qualifiers="const">
			<return type="int" />
			<description>
				Returns the colliding body's shape index, if a collision occurred. See [CollisionObject2D].
			</description>
		</method>
		<method name="get_collider_velocity" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the colliding body's velocity, if a collision occurred.
			</description>
		</method>
		<method name="get_collision_depth" qualifiers="const">
			<return type="float" />
			<description>
				Returns the length of overlap along the collision normal, if a collision occurred.
			</description>
		</method>
		<method name="get_collision_local_shape" qualifiers="const">
			<return type="int" />
			<description>
				Returns the moving object's colliding shape, if a collision occurred.
			</description>
		</method>
		<method name="get_collision_normal" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the colliding body's shape's normal at the point of collision, if a collision occurred.
			</description>
		</method>
		<method name="get_collision_point" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the point of collision in global coordinates, if a collision occurred.
			</description>
		</method>
		<method name="get_collision_safe_fraction" qualifiers="const">
			<return type="float" />
			<description>
				Returns the maximum fraction of the motion that can occur without a collision, between [code]0[/code] and [code]1[/code].
			</description>
		</method>
		<method name="get_collision_unsafe_fraction" qualifiers="const">
			<return type="float" />
			<description>
				Returns the minimum fraction of the motion needed to collide, if a collision occurred, between [code]0[/code] and [code]1[/code].
			</description>
		</method>
		<method name="get_remainder" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the moving object's remaining movement vector.
			</description>
		</method>
		<method name="get_travel" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the moving object's travel before collision.
			</description>
		</method>
	</methods>
</class>