seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Use "param" instead of "code" to refer to parameters (4)

Browse Source
This commit is contained in:
Andy Maloney
2022-08-11 13:52:19 -04:00
parent ad247899ab
commit 1df86ecea5
34 changed files with 209 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/PhysicsBody3D.xml
View File

@ -21,7 +21,7 @@
<return type="bool" />
<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.
Returns [code]true[/code] if the specified linear or rotational [param axis] is locked.
</description>
</method>
<method name="get_collision_exceptions">
@ -37,11 +37,11 @@
<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].
Moves the body along the vector [param distance]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [param distance] 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.
If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given.
[code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[code]max_collisions[/code] allows to retrieve more than one collision result.
If [param test_only] is [code]true[/code], the body does not move but the would-be collision information is given.
[param safe_margin] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[param max_collisions] allows to retrieve more than one collision result.
</description>
</method>
<method name="remove_collision_exception_with">
@ -56,7 +56,7 @@
<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].
Locks or unlocks the specified linear or rotational [param axis] depending on the value of [param lock].
</description>
</method>
<method name="test_move">
@ -67,11 +67,11 @@
<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.
[code]collision[/code] is an optional object of type [KinematicCollision3D], which contains additional information about the collision when stopped, or when touching another body along the motion.
[code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[code]max_collisions[/code] allows to retrieve more than one collision result.
Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [param distance] 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 [param distance]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path.
[param collision] is an optional object of type [KinematicCollision3D], which contains additional information about the collision when stopped, or when touching another body along the motion.
[param safe_margin] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[param max_collisions] allows to retrieve more than one collision result.
</description>
</method>
</methods>