diff options
Diffstat (limited to 'doc/classes/Shape2D.xml')
-rw-r--r-- | doc/classes/Shape2D.xml | 69 |
1 files changed, 23 insertions, 46 deletions
diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 65a37314f6..c1191aa9de 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -11,76 +11,53 @@ </tutorials> <methods> <method name="collide"> - <return type="bool"> - </return> - <argument index="0" name="local_xform" type="Transform2D"> - </argument> - <argument index="1" name="with_shape" type="Shape2D"> - </argument> - <argument index="2" name="shape_xform" type="Transform2D"> - </argument> + <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" /> <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]). </description> </method> <method name="collide_and_get_contacts"> - <return type="Array"> - </return> - <argument index="0" name="local_xform" type="Transform2D"> - </argument> - <argument index="1" name="with_shape" type="Shape2D"> - </argument> - <argument index="2" name="shape_xform" type="Transform2D"> - </argument> + <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" /> <description> Returns a list of the points where this shape touches another. If there are no collisions the list is empty. 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]). </description> </method> <method name="collide_with_motion"> - <return type="bool"> - </return> - <argument index="0" name="local_xform" type="Transform2D"> - </argument> - <argument index="1" name="local_motion" type="Vector2"> - </argument> - <argument index="2" name="with_shape" type="Shape2D"> - </argument> - <argument index="3" name="shape_xform" type="Transform2D"> - </argument> - <argument index="4" name="shape_motion" type="Vector2"> - </argument> + <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" /> <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]). </description> </method> <method name="collide_with_motion_and_get_contacts"> - <return type="Array"> - </return> - <argument index="0" name="local_xform" type="Transform2D"> - </argument> - <argument index="1" name="local_motion" type="Vector2"> - </argument> - <argument index="2" name="with_shape" type="Shape2D"> - </argument> - <argument index="3" name="shape_xform" type="Transform2D"> - </argument> - <argument index="4" name="shape_motion" type="Vector2"> - </argument> + <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" /> <description> Returns a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions the list is empty. 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]). </description> </method> <method name="draw"> - <return type="void"> - </return> - <argument index="0" name="canvas_item" type="RID"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> + <return type="void" /> + <argument index="0" name="canvas_item" type="RID" /> + <argument 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> |