summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsBody3D.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:28:05 +0200
committerRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:29:52 +0200
commit7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch)
tree0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/PhysicsBody3D.xml
parenta1c19b9a1e53f78c75c13cb418270db80057b21a (diff)
doc: Use self-closing tags for `return` and `argument`
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
Diffstat (limited to 'doc/classes/PhysicsBody3D.xml')
-rw-r--r--doc/classes/PhysicsBody3D.xml69
1 files changed, 23 insertions, 46 deletions
diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml
index 1ec38000be..a2a68115d0 100644
--- a/doc/classes/PhysicsBody3D.xml
+++ b/doc/classes/PhysicsBody3D.xml
@@ -11,43 +11,32 @@
</tutorials>
<methods>
<method name="add_collision_exception_with">
- <return type="void">
- </return>
- <argument index="0" name="body" type="Node">
- </argument>
+ <return type="void" />
+ <argument 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">
- </return>
- <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis">
- </argument>
+ <return type="bool" />
+ <argument 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>
</method>
<method name="get_collision_exceptions">
- <return type="PhysicsBody3D[]">
- </return>
+ <return type="PhysicsBody3D[]" />
<description>
Returns an array of nodes that were added as collision exceptions for this body.
</description>
</method>
<method name="move_and_collide">
- <return type="KinematicCollision3D">
- </return>
- <argument index="0" name="rel_vec" type="Vector3">
- </argument>
- <argument index="1" name="infinite_inertia" type="bool" default="true">
- </argument>
- <argument index="2" name="exclude_raycast_shapes" type="bool" default="true">
- </argument>
- <argument index="3" name="test_only" type="bool" default="false">
- </argument>
- <argument index="4" name="safe_margin" type="float" default="0.001">
- </argument>
+ <return type="KinematicCollision3D" />
+ <argument index="0" name="rel_vec" type="Vector3" />
+ <argument index="1" name="infinite_inertia" type="bool" default="true" />
+ <argument index="2" name="exclude_raycast_shapes" type="bool" default="true" />
+ <argument index="3" name="test_only" type="bool" default="false" />
+ <argument index="4" name="safe_margin" type="float" default="0.001" />
<description>
Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision.
If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given.
@@ -55,40 +44,28 @@
</description>
</method>
<method name="remove_collision_exception_with">
- <return type="void">
- </return>
- <argument index="0" name="body" type="Node">
- </argument>
+ <return type="void" />
+ <argument 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">
- </return>
- <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis">
- </argument>
- <argument index="1" name="lock" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis" />
+ <argument 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">
- </return>
- <argument index="0" name="from" type="Transform3D">
- </argument>
- <argument index="1" name="rel_vec" type="Vector3">
- </argument>
- <argument index="2" name="infinite_inertia" type="bool" default="true">
- </argument>
- <argument index="3" name="exclude_raycast_shapes" type="bool" default="true">
- </argument>
- <argument index="4" name="collision" type="KinematicCollision3D" default="null">
- </argument>
- <argument index="5" name="safe_margin" type="float" default="0.001">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="from" type="Transform3D" />
+ <argument index="1" name="rel_vec" type="Vector3" />
+ <argument index="2" name="infinite_inertia" type="bool" default="true" />
+ <argument index="3" name="exclude_raycast_shapes" type="bool" default="true" />
+ <argument index="4" name="collision" type="KinematicCollision3D" default="null" />
+ <argument index="5" name="safe_margin" type="float" default="0.001" />
<description>
Checks for collisions without moving the body. 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]rel_vec[/code]. Returns [code]true[/code] if a collision would occur.
[code]collision[/code] is an optional object of type [KinematicCollision3D], which contains additional information about the collision (should there be one).