godot/doc/classes/KinematicCollision2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="KinematicCollision2D" inherits="RefCounted" version="4.0">
	<brief_description>
		Collision data for [method PhysicsBody2D.move_and_collide] collisions.
	</brief_description>
	<description>
		Contains collision data for [method PhysicsBody2D.move_and_collide] collisions. When a [PhysicsBody2D] is moved using [method PhysicsBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a [KinematicCollision2D] object is returned.
		This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_angle" qualifiers="const">
			<return type="float" />
			<argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" />
			<description>
				The collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive.
			</description>
		</method>
	</methods>
	<members>
		<member name="collider" type="Object" setter="" getter="get_collider">
			The colliding body.
		</member>
		<member name="collider_id" type="int" setter="" getter="get_collider_id" default="0">
			The colliding body's unique instance ID. See [method Object.get_instance_id].
		</member>
		<member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata">
			The colliding body's metadata. See [Object].
		</member>
		<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">
			The colliding body's [RID] used by the [PhysicsServer2D].
		</member>
		<member name="collider_shape" type="Object" setter="" getter="get_collider_shape">
			The colliding body's shape.
		</member>
		<member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0">
			The colliding shape's index. See [CollisionObject2D].
		</member>
		<member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)">
			The colliding object's velocity.
		</member>
		<member name="local_shape" type="Object" setter="" getter="get_local_shape">
			The moving object's colliding shape.
		</member>
		<member name="normal" type="Vector2" setter="" getter="get_normal" default="Vector2(0, 0)">
			The colliding body's shape's normal at the point of collision.
		</member>
		<member name="position" type="Vector2" setter="" getter="get_position" default="Vector2(0, 0)">
			The point of collision, in global coordinates.
		</member>
		<member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)">
			The moving object's remaining movement vector.
		</member>
		<member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)">
			The distance the moving object traveled before collision.
		</member>
	</members>
	<constants>
	</constants>
</class>
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Rename Reference to RefCounted 2021-06-05 00:03:15 +08:00			`<class name="KinematicCollision2D" inherits="RefCounted" version="4.0">`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`<brief_description>`
KinematicBody split between new CharacterBody and PhysicsBody PhysicsBody now has methods move_and_collide/test_move and needed properties for these methods: safe margin, locked axes (3D only). Moved collision_exceptions from StaticBody to PhysicsBody for 3D (same as 2D, and conforms to documentation). RigidBody doesn't have test_motion method anymore, it's now redundant with PhysicsBody.test_move. 2021-05-20 09:14:33 +08:00			`Collision data for [method PhysicsBody2D.move_and_collide] collisions.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</brief_description>`
			`<description>`
KinematicBody split between new CharacterBody and PhysicsBody PhysicsBody now has methods move_and_collide/test_move and needed properties for these methods: safe margin, locked axes (3D only). Moved collision_exceptions from StaticBody to PhysicsBody for 3D (same as 2D, and conforms to documentation). RigidBody doesn't have test_motion method anymore, it's now redundant with PhysicsBody.test_move. 2021-05-20 09:14:33 +08:00			`Contains collision data for [method PhysicsBody2D.move_and_collide] collisions. When a [PhysicsBody2D] is moved using [method PhysicsBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a [KinematicCollision2D] object is returned.`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
API improvement on physics, mainly CharacterBody Changes: - Rename few methods/property and group them in the editor when it's possible - Make MotionResult API consistency with KinematicCollision - Return a boolean in move_and_slide if there was a collision - New methods: - get_floor_angle on CharacterBody to get the floor angle. - get_angle on KinematicCollision to get the collision angle. - get_last_slide_collision to quickly get the latest collision of move_and_slide. 2021-08-13 06:41:40 +08:00			`<method name="get_angle" qualifiers="const">`
			`<return type="float" />`
			`<argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" />`
			`<description>`
			`The collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive.`
			`</description>`
			`</method>`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</methods>`
			`<members>`
doc: Sync classref with current source 2019-07-16 02:42:47 +08:00			`<member name="collider" type="Object" setter="" getter="get_collider">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding body.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="collider_id" type="int" setter="" getter="get_collider_id" default="0">`
Fix KinematicCollision docs mislabeling an ObjectID as an RID. 2019-12-25 05:35:58 +08:00			`The colliding body's unique instance ID. See [method Object.get_instance_id].`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-30 03:22:15 +08:00			`<member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding body's metadata. See [Object].`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Expose collider RID in 2D/3D kinematic collision Can be useful to access the colliding body information for bodies created with the physics server directly. 2021-06-10 09:00:41 +08:00			`<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">`
			`The colliding body's [RID] used by the [PhysicsServer2D].`
			`</member>`
doc: Sync classref with current source 2019-07-16 02:42:47 +08:00			`<member name="collider_shape" type="Object" setter="" getter="get_collider_shape">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding body's shape.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding shape's index. See [CollisionObject2D].`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding object's velocity.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
doc: Sync classref with current source 2019-07-16 02:42:47 +08:00			`<member name="local_shape" type="Object" setter="" getter="get_local_shape">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The moving object's colliding shape.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="normal" type="Vector2" setter="" getter="get_normal" default="Vector2(0, 0)">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The colliding body's shape's normal at the point of collision.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="position" type="Vector2" setter="" getter="get_position" default="Vector2(0, 0)">`
Mention that KinematicCollisions use global coords 2020-01-20 03:22:31 +08:00			`The point of collision, in global coordinates.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The moving object's remaining movement vector.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)">`
Document new KinematicCollision2D class 2017-09-15 07:04:36 +08:00			`The distance the moving object traveled before collision.`
doc: Sync classref with current source [ci skip] 2017-09-14 02:56:01 +08:00			`</member>`
			`</members>`
			`<constants>`
			`</constants>`
			`</class>`