diff options
Diffstat (limited to 'doc/classes/Shape2D.xml')
| -rw-r--r-- | doc/classes/Shape2D.xml | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 94fb2d7dc7..8f5ca034e4 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -12,9 +12,9 @@ <methods> <method name="collide"> <return type="bool" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="with_shape" type="Shape2D" /> - <argument index="2" name="shape_xform" type="Transform2D" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="with_shape" type="Shape2D" /> + <param index="2" name="shape_xform" type="Transform2D" /> <description> Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). @@ -22,9 +22,9 @@ </method> <method name="collide_and_get_contacts"> <return type="Array" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="with_shape" type="Shape2D" /> - <argument index="2" name="shape_xform" type="Transform2D" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="with_shape" type="Shape2D" /> + <param index="2" name="shape_xform" type="Transform2D" /> <description> Returns a list of contact point pairs where this shape touches another. If there are no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -34,11 +34,11 @@ </method> <method name="collide_with_motion"> <return type="bool" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="local_motion" type="Vector2" /> - <argument index="2" name="with_shape" type="Shape2D" /> - <argument index="3" name="shape_xform" type="Transform2D" /> - <argument index="4" name="shape_motion" type="Vector2" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="local_motion" type="Vector2" /> + <param index="2" name="with_shape" type="Shape2D" /> + <param index="3" name="shape_xform" type="Transform2D" /> + <param index="4" name="shape_motion" type="Vector2" /> <description> Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). @@ -46,11 +46,11 @@ </method> <method name="collide_with_motion_and_get_contacts"> <return type="Array" /> - <argument index="0" name="local_xform" type="Transform2D" /> - <argument index="1" name="local_motion" type="Vector2" /> - <argument index="2" name="with_shape" type="Shape2D" /> - <argument index="3" name="shape_xform" type="Transform2D" /> - <argument index="4" name="shape_motion" type="Vector2" /> + <param index="0" name="local_xform" type="Transform2D" /> + <param index="1" name="local_motion" type="Vector2" /> + <param index="2" name="with_shape" type="Shape2D" /> + <param index="3" name="shape_xform" type="Transform2D" /> + <param index="4" name="shape_motion" type="Vector2" /> <description> Returns a list of contact point pairs where this shape would touch another, if a given movement was applied. If there would be no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -60,8 +60,8 @@ </method> <method name="draw"> <return type="void" /> - <argument index="0" name="canvas_item" type="RID" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="canvas_item" type="RID" /> + <param index="1" name="color" type="Color" /> <description> Draws a solid shape onto a [CanvasItem] with the [RenderingServer] API filled with the specified [code]color[/code]. The exact drawing method is specific for each shape and cannot be configured. </description> |