d0ec46be68
Shape metadata was only used to get tile information when colliding with tilemaps. It's not needed anymore since there's an API in tilemap using body ids instead.
122 lines
5.4 KiB
XML
122 lines
5.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="KinematicCollision3D" inherits="RefCounted" version="4.0">
|
|
<brief_description>
|
|
Collision data for [method PhysicsBody3D.move_and_collide] collisions.
|
|
</brief_description>
|
|
<description>
|
|
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.
|
|
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>
|
|
<method name="get_angle" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<argument index="1" 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>
|
|
<method name="get_collider" qualifiers="const">
|
|
<return type="Object" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_collider_id" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider ID by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_collider_rid" qualifiers="const">
|
|
<return type="RID" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider RID by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_collider_shape" qualifiers="const">
|
|
<return type="Object" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider shape by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_collider_shape_index" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider shape index by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_collider_velocity" qualifiers="const">
|
|
<return type="Vector3" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider velocity by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_local_shape" qualifiers="const">
|
|
<return type="Object" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider velocity by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_normal" qualifiers="const">
|
|
<return type="Vector3" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider normal by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
<method name="get_position" qualifiers="const">
|
|
<return type="Vector3" />
|
|
<argument index="0" name="collision_index" type="int" default="0" />
|
|
<description>
|
|
Returns the collider collision point by index (the latest by default).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="collider" type="Object" setter="" getter="get_best_collider">
|
|
The colliding body.
|
|
</member>
|
|
<member name="collider_id" type="int" setter="" getter="get_best_collider_id" default="0">
|
|
The colliding body's unique instance ID. See [method Object.get_instance_id].
|
|
</member>
|
|
<member name="collider_rid" type="RID" setter="" getter="get_best_collider_rid">
|
|
The colliding body's [RID] used by the [PhysicsServer3D].
|
|
</member>
|
|
<member name="collider_shape" type="Object" setter="" getter="get_best_collider_shape">
|
|
The colliding body's shape.
|
|
</member>
|
|
<member name="collider_shape_index" type="int" setter="" getter="get_best_collider_shape_index" default="0">
|
|
The colliding shape's index. See [CollisionObject3D].
|
|
</member>
|
|
<member name="collider_velocity" type="Vector3" setter="" getter="get_best_collider_velocity" default="Vector3(0, 0, 0)">
|
|
The colliding object's velocity.
|
|
</member>
|
|
<member name="collision_count" type="int" setter="" getter="get_collision_count" default="0">
|
|
</member>
|
|
<member name="local_shape" type="Object" setter="" getter="get_best_local_shape">
|
|
The moving object's colliding shape.
|
|
</member>
|
|
<member name="normal" type="Vector3" setter="" getter="get_best_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_best_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>
|
|
</class>
|