godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/KinematicCollision3D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

110 lines
4.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="KinematicCollision3D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (Physics classes)
2023-04-28 20:59:03 +00:00
Holds collision data from the movement of a [PhysicsBody3D].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (Physics classes)
2023-04-28 20:59:03 +00:00
Holds collision data from the movement of a [PhysicsBody3D], usually from [method PhysicsBody3D.move_and_collide]. When a [PhysicsBody3D] is moved, it stops if it detects a collision with another body. If a collision is detected, a [KinematicCollision3D] object is returned.
The collision data includes the colliding object, the remaining motion, and the collision position. This data can be used to determine a custom response to the collision.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00: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-12 22:41:40 +00:00
<method name="get_angle" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
<param index="1" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" />
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-12 22:41:40 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns the collision angle according to [param up_direction], which is [constant Vector3.UP] by default. This value is always positive.
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-12 22:41:40 +00:00
</description>
</method>
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<method name="get_collider" qualifiers="const">
<return type="Object" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's attached [Object] given a collision index (the deepest collision by default).
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_collider_id" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id].
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_collider_rid" qualifiers="const">
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default).
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_collider_shape" qualifiers="const">
<return type="Object" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's shape given a collision index (the deepest collision by default).
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_collider_shape_index" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D].
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_collider_velocity" qualifiers="const">
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's velocity given a collision index (the deepest collision by default).
</description>
</method>
<method name="get_collision_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of detected collisions.
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
add get_depth() to KinematicCollision3D as same of 2D
2022-08-10 01:14:36 +00:00
<method name="get_depth" qualifiers="const">
<return type="float" />
<description>
Returns the colliding body's length of overlap along the collision normal.
</description>
</method>
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<method name="get_local_shape" qualifiers="const">
<return type="Object" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the moving object's colliding shape given a collision index (the deepest collision by default).
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_normal" qualifiers="const">
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default).
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="collision_index" type="int" default="0" />
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the point of collision in global coordinates given a collision index (the deepest collision by default).
</description>
</method>
<method name="get_remainder" qualifiers="const">
<return type="Vector3" />
<description>
Returns the moving object's remaining movement vector.
</description>
</method>
<method name="get_travel" qualifiers="const">
<return type="Vector3" />
<description>
Returns the moving object's travel before collision.
Port 2D improvement to move and slide 3D Co-authored-by: Camille Mohr-Daurat <pouleyketchoup@gmail.com>
2021-08-30 18:49:09 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
</class>