virtualx-engine/doc/classes/KinematicCollision.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="KinematicCollision" inherits="Reference" version="3.4">
	<brief_description>
		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.
		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>
	</tutorials>
	<methods>
	</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_metadata" type="Variant" setter="" getter="get_collider_metadata">
			The colliding body's metadata. See [Object].
		</member>
		<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">
			The colliding body's [RID] used by the [PhysicsServer].
		</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 [CollisionObject].
		</member>
		<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">
			The moving object's colliding shape.
		</member>
		<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" default="Vector3( 0, 0, 0 )">
			The point of collision, in global coordinates.
		</member>
		<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" default="Vector3( 0, 0, 0 )">
			The distance the moving object traveled before collision.
		</member>
	</members>
	<constants>
	</constants>
</class>
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" ?>`
doc: Update classref headers with 3.4 version 2021-04-26 13:14:51 +02:00			`<class name="KinematicCollision" inherits="Reference" version="3.4">`
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>`
			`</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>`