diff options
Diffstat (limited to 'doc/classes/KinematicCollision2D.xml')
| -rw-r--r-- | doc/classes/KinematicCollision2D.xml | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index ec6e16e25a..721b840e99 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -1,15 +1,22 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision2D" inherits="Reference" version="4.0"> +<class name="KinematicCollision2D" inherits="RefCounted" version="4.0"> <brief_description> - Collision data for [KinematicBody2D] collisions. + Collision data for [method PhysicsBody2D.move_and_collide] collisions. </brief_description> <description> - Contains collision data for [KinematicBody2D] collisions. When a [KinematicBody2D] is moved using [method KinematicBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. + 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"> @@ -21,28 +28,31 @@ <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 )"> + <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 )"> + <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 )"> + <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 )"> + <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 )"> + <member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)"> The distance the moving object traveled before collision. </member> </members> |