diff options
Diffstat (limited to 'doc/classes/KinematicCollision.xml')
| -rw-r--r-- | doc/classes/KinematicCollision.xml | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 4ce74df767..4ce28b25c9 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="KinematicCollision" inherits="Reference" category="Core" version="3.2"> <brief_description> - Collision data for KinematicBody collisions. + Collision data for [KinematicBody] collisions. </brief_description> <description> - Contains collision data for KinematicBody collisions. When a [KinematicBody] is moved using [method KinematicBody.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. + Contains collision data for [KinematicBody] collisions. When a [KinematicBody] is moved using [method KinematicBody.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision 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> @@ -12,37 +12,37 @@ <methods> </methods> <members> - <member name="collider" type="Object" setter="" getter="get_collider"> + <member name="collider" type="Object" setter="" getter="get_collider" default="null"> The colliding body. </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id"> + <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> The colliding body's unique [RID]. </member> <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> The colliding body's metadata. See [Object]. </member> - <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> + <member name="collider_shape" type="Object" setter="" getter="get_collider_shape" default="null"> The colliding body's shape. </member> - <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index"> + <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0"> The colliding shape's index. See [CollisionObject]. </member> - <member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity"> + <member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity" default="Vector3( 0, 0, 0 )"> The colliding object's velocity. </member> - <member name="local_shape" type="Object" setter="" getter="get_local_shape"> + <member name="local_shape" type="Object" setter="" getter="get_local_shape" default="null"> The moving object's colliding shape. </member> - <member name="normal" type="Vector3" setter="" getter="get_normal"> + <member name="normal" type="Vector3" setter="" getter="get_normal" default="Vector3( 0, 0, 0 )"> The colliding body's shape's normal at the point of collision. </member> - <member name="position" type="Vector3" setter="" getter="get_position"> + <member name="position" type="Vector3" setter="" getter="get_position" default="Vector3( 0, 0, 0 )"> The point of collision. </member> - <member name="remainder" type="Vector3" setter="" getter="get_remainder"> + <member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3( 0, 0, 0 )"> The moving object's remaining movement vector. </member> - <member name="travel" type="Vector3" setter="" getter="get_travel"> + <member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3( 0, 0, 0 )"> The distance the moving object traveled before collision. </member> </members> |