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

62 lines
3.0 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" ?>
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
<class name="KinematicCollision3D" inherits="RefCounted" version="4.0">
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>
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 01:14:33 +00:00
Collision data for [method PhysicsBody3D.move_and_collide] collisions.
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>
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 01:14:33 +00:00
Contains collision data for [method PhysicsBody3D.move_and_collide] collisions. When a [PhysicsBody3D] is moved using [method PhysicsBody3D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a [KinematicCollision3D] object is returned.
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00: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.
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" />
<argument index="0" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" />
<description>
The collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive.
</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>
<members>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="collider" type="Object" setter="" getter="get_collider">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The colliding body.
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
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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-24 21:35:58 +00:00
The colliding body's unique instance ID. See [method Object.get_instance_id].
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
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The colliding body's metadata. See [Object].
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
</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 01:00:41 +00:00
<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">
The colliding body's [RID] used by the [PhysicsServer3D].
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="collider_shape" type="Object" setter="" getter="get_collider_shape">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The colliding body's shape.
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
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
The colliding shape's index. See [CollisionObject3D].
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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity" default="Vector3(0, 0, 0)">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The colliding object's velocity.
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
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="local_shape" type="Object" setter="" getter="get_local_shape">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The moving object's colliding shape.
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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="normal" type="Vector3" setter="" getter="get_normal" default="Vector3(0, 0, 0)">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The colliding body's shape's normal at the point of 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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="position" type="Vector3" setter="" getter="get_position" default="Vector3(0, 0, 0)">
Mention that KinematicCollisions use global coords
2020-01-19 19:22:31 +00:00
The point of collision, in global coordinates.
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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3(0, 0, 0)">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The moving object's remaining movement vector.
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
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3(0, 0, 0)">
[DOCS] Add KinematicCollision descriptions
2017-09-17 04:56:03 +00:00
The distance the moving object traveled before 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
</member>
</members>
<constants>
</constants>
</class>
Reference in New Issue Copy Permalink