asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/KinematicCollision.xml

62 lines
3.1 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
<class name="KinematicCollision" inherits="Reference" version="3.5" 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 22:42:36 +02:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Collision data for [KinematicBody] 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 22:42:36 +02:00
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
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.
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
Backport new methods for KinematicBody and KinematicCollision For both 2D and 3D, three methods are added: - `get_floor_angle` on `KinematicBody` 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-26 06:16:40 +02: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 22:42:36 +02:00
</methods>
<members>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="collider" type="Object" setter="" getter="get_collider">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 22:35:58 +01: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 22:42:36 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02: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 03:24:15 +02:00
<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">
The colliding body's [RID] used by the [PhysicsServer].
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="collider_shape" type="Object" setter="" getter="get_collider_shape">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02:00
The colliding shape's index. See [CollisionObject].
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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity" default="Vector3( 0, 0, 0 )">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="local_shape" type="Object" setter="" getter="get_local_shape">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="normal" type="Vector3" setter="" getter="get_normal" default="Vector3( 0, 0, 0 )">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="position" type="Vector3" setter="" getter="get_position" default="Vector3( 0, 0, 0 )">
Mention that KinematicCollisions use global coords
2020-01-19 20:22:31 +01: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3( 0, 0, 0 )">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3( 0, 0, 0 )">
[DOCS] Add KinematicCollision descriptions
2017-09-17 06:56:03 +02: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 22:42:36 +02:00
</member>
</members>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink