summaryrefslogtreecommitdiff
path: root/doc/classes/ShapeCast2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ShapeCast2D.xml')
-rw-r--r--doc/classes/ShapeCast2D.xml34
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml
index 70da03dc6e..36c3beecb1 100644
--- a/doc/classes/ShapeCast2D.xml
+++ b/doc/classes/ShapeCast2D.xml
@@ -14,14 +14,14 @@
<methods>
<method name="add_exception">
<return type="void" />
- <argument index="0" name="node" type="CollisionObject2D" />
+ <param index="0" name="node" type="CollisionObject2D" />
<description>
Adds a collision exception so the shape does not report collisions with the specified [CollisionObject2D] node.
</description>
</method>
<method name="add_exception_rid">
<return type="void" />
- <argument index="0" name="rid" type="RID" />
+ <param index="0" name="rid" type="RID" />
<description>
Adds a collision exception so the shape does not report collisions with the specified [RID].
</description>
@@ -53,16 +53,16 @@
</method>
<method name="get_collider" qualifiers="const">
<return type="Object" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
- Returns the collided [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
+ Returns the collided [Object] of one of the multiple collisions at [param index], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
</description>
</method>
<method name="get_collider_shape" qualifiers="const">
<return type="int" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
- Returns the shape ID of the colliding shape of one of the multiple collisions at [code]index[/code], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
+ Returns the shape ID of the colliding shape of one of the multiple collisions at [param index], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]).
</description>
</method>
<method name="get_collision_count" qualifiers="const">
@@ -73,23 +73,23 @@
</method>
<method name="get_collision_mask_value" qualifiers="const">
<return type="bool" />
- <argument index="0" name="layer_number" type="int" />
+ <param index="0" name="layer_number" type="int" />
<description>
- Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32.
+ Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [param layer_number] between 1 and 32.
</description>
</method>
<method name="get_collision_normal" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
- Returns the normal of one of the multiple collisions at [code]index[/code] of the intersecting object.
+ Returns the normal of one of the multiple collisions at [param index] of the intersecting object.
</description>
</method>
<method name="get_collision_point" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
- Returns the collision point of one of the multiple collisions at [code]index[/code] where the shape intersects the colliding object.
+ Returns the collision point of one of the multiple collisions at [param index] where the shape intersects the colliding object.
[b]Note:[/b] this point is in the [b]global[/b] coordinate system.
</description>
</method>
@@ -101,24 +101,24 @@
</method>
<method name="remove_exception">
<return type="void" />
- <argument index="0" name="node" type="CollisionObject2D" />
+ <param index="0" name="node" type="CollisionObject2D" />
<description>
Removes a collision exception so the shape does report collisions with the specified [CollisionObject2D] node.
</description>
</method>
<method name="remove_exception_rid">
<return type="void" />
- <argument index="0" name="rid" type="RID" />
+ <param index="0" name="rid" type="RID" />
<description>
Removes a collision exception so the shape does report collisions with the specified [RID].
</description>
</method>
<method name="set_collision_mask_value">
<return type="void" />
- <argument index="0" name="layer_number" type="int" />
- <argument index="1" name="value" type="bool" />
+ <param index="0" name="layer_number" type="int" />
+ <param index="1" name="value" type="bool" />
<description>
- Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32.
+ Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32.
</description>
</method>
</methods>