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

94 lines
3.5 KiB
XML
Raw Normal View History

doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
<class name="KinematicCollision2D" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02: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 03:14:33 +02:00
Collision data for [method PhysicsBody2D.move_and_collide] collisions.
doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02: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 03:14:33 +02:00
Contains collision data for [method PhysicsBody2D.move_and_collide] collisions. When a [PhysicsBody2D] is moved using [method PhysicsBody2D.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a [KinematicCollision2D] object is returned.
Document new KinematicCollision2D class
2017-09-15 01:04:36 +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.
doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02: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-13 00:41:40 +02:00
<method name="get_angle" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" />
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-13 00:41:40 +02:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 15:36:48 +02:00
Returns the collision angle according to [param up_direction], which is [constant Vector2.UP] by default. This value is always positive.
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 20:28:57 +02:00
</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>
add get_depth() to KinematicCollision3D as same of 2D
2022-08-10 03:14:36 +02: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>
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 20:28:57 +02:00
<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.
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-13 00:41:40 +02:00
</description>
</method>
doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02:00
</methods>
</class>
Reference in a new issue Copy permalink