diff options
Diffstat (limited to 'doc/classes/KinematicCollision3D.xml')
| -rw-r--r-- | doc/classes/KinematicCollision3D.xml | 97 |
1 files changed, 84 insertions, 13 deletions
diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 5477736c25..db32cf57bc 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -12,41 +12,114 @@ <methods> <method name="get_angle" qualifiers="const"> <return type="float" /> - <argument index="0" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> + <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_metadata" qualifiers="const"> + <return type="Variant" /> + <argument index="0" name="collision_index" type="int" default="0" /> + <description> + Returns the collider metadata 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_collider"> + <member name="collider" type="Object" setter="" getter="get_best_collider"> The colliding body. </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> + <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_metadata" type="Variant" setter="" getter="get_collider_metadata"> + <member name="collider_metadata" type="Variant" setter="" getter="get_best_collider_metadata"> The colliding body's metadata. See [Object]. </member> - <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> + <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_collider_shape"> + <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_collider_shape_index" default="0"> + <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_collider_velocity" default="Vector3(0, 0, 0)"> + <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="local_shape" type="Object" setter="" getter="get_local_shape"> + <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_normal" default="Vector3(0, 0, 0)"> + <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_position" default="Vector3(0, 0, 0)"> + <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)"> @@ -56,6 +129,4 @@ The distance the moving object traveled before collision. </member> </members> - <constants> - </constants> </class> |