diff options
Diffstat (limited to 'doc/classes/KinematicCollision2D.xml')
| -rw-r--r-- | doc/classes/KinematicCollision2D.xml | 103 |
1 files changed, 67 insertions, 36 deletions
diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 29fc4700fd..23b01a0fc9 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -14,43 +14,74 @@ <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. + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's attached [Object]. + </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]. 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]. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's shape. + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int" /> + <description> + Returns the colliding body's shape index. See [CollisionObject2D]. + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's velocity. + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the moving object's colliding shape. + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's shape's normal at the point of collision. + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the point of collision in global coordinates. + </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> - <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_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> </class> |