summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsBody3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PhysicsBody3D.xml')
-rw-r--r--doc/classes/PhysicsBody3D.xml28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml
index 843f813997..4a641e5040 100644
--- a/doc/classes/PhysicsBody3D.xml
+++ b/doc/classes/PhysicsBody3D.xml
@@ -12,14 +12,14 @@
<methods>
<method name="add_collision_exception_with">
<return type="void" />
- <argument index="0" name="body" type="Node" />
+ <param index="0" name="body" type="Node" />
<description>
Adds a body to the list of bodies that this body can't collide with.
</description>
</method>
<method name="get_axis_lock" qualifiers="const">
<return type="bool" />
- <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" />
+ <param index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" />
<description>
Returns [code]true[/code] if the specified linear or rotational [code]axis[/code] is locked.
</description>
@@ -32,10 +32,10 @@
</method>
<method name="move_and_collide">
<return type="KinematicCollision3D" />
- <argument index="0" name="distance" type="Vector3" />
- <argument index="1" name="test_only" type="bool" default="false" />
- <argument index="2" name="safe_margin" type="float" default="0.001" />
- <argument index="3" name="max_collisions" type="int" default="1" />
+ <param index="0" name="distance" type="Vector3" />
+ <param index="1" name="test_only" type="bool" default="false" />
+ <param index="2" name="safe_margin" type="float" default="0.001" />
+ <param index="3" name="max_collisions" type="int" default="1" />
<description>
Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code].
The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion.
@@ -46,26 +46,26 @@
</method>
<method name="remove_collision_exception_with">
<return type="void" />
- <argument index="0" name="body" type="Node" />
+ <param index="0" name="body" type="Node" />
<description>
Removes a body from the list of bodies that this body can't collide with.
</description>
</method>
<method name="set_axis_lock">
<return type="void" />
- <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" />
- <argument index="1" name="lock" type="bool" />
+ <param index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" />
+ <param index="1" name="lock" type="bool" />
<description>
Locks or unlocks the specified linear or rotational [code]axis[/code] depending on the value of [code]lock[/code].
</description>
</method>
<method name="test_move">
<return type="bool" />
- <argument index="0" name="from" type="Transform3D" />
- <argument index="1" name="distance" type="Vector3" />
- <argument index="2" name="collision" type="KinematicCollision3D" default="null" />
- <argument index="3" name="safe_margin" type="float" default="0.001" />
- <argument index="4" name="max_collisions" type="int" default="1" />
+ <param index="0" name="from" type="Transform3D" />
+ <param index="1" name="distance" type="Vector3" />
+ <param index="2" name="collision" type="KinematicCollision3D" default="null" />
+ <param index="3" name="safe_margin" type="float" default="0.001" />
+ <param index="4" name="max_collisions" type="int" default="1" />
<description>
Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code].
Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path.