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

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
doc/classes/TileSetAtlasSource.xml
View File

@ -17,8 +17,8 @@
<methods>
<method name="create_alternative_tile">
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_id_override" type="int" default="-1" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_id_override" type="int" default="-1" />
<description>
Creates an alternative tile for the tile at coords [code]atlas_coords[/code]. If [code]alternative_id_override[/code] is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise.
Returns the new alternative identifier, or -1 if the alternative could not be created with a provided [code]alternative_id_override[/code].
@ -26,8 +26,8 @@
</method>
<method name="create_tile">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" />
<description>
Creates a new tile at coords [code]atlas_coords[/code] with size [code]size[/code].
</description>
@ -40,7 +40,7 @@
</method>
<method name="get_next_alternative_tile_id" qualifiers="const">
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the alternative ID a following call to [method create_alternative_tile] would return.
</description>
@ -53,8 +53,8 @@
</method>
<method name="get_runtime_tile_texture_region" qualifiers="const">
<return type="Rect2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame" type="int" />
<description>
Returns the region of the tile at coordinates [code]atlas_coords[/code] for frame [code]frame[/code] inside the texture returned by [method get_runtime_texture].
[b]Note:[/b] If [member use_texture_padding] is [code]false[/code], returns the same as [method get_tile_texture_region].
@ -62,104 +62,104 @@
</method>
<method name="get_tile_animation_columns" qualifiers="const">
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns how many columns the tile at [code]atlas_coords[/code] has in its animation layout.
</description>
</method>
<method name="get_tile_animation_frame_duration" qualifiers="const">
<return type="float" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_index" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_index" type="int" />
<description>
Returns the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="get_tile_animation_frames_count" qualifiers="const">
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns how many animation frames has the tile at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="get_tile_animation_separation" qualifiers="const">
<return type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="get_tile_animation_speed" qualifiers="const">
<return type="float" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the animation speed of the tile at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="get_tile_animation_total_duration" qualifiers="const">
<return type="float" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the sum of the sum of the frame durations of the tile at coordinates [code]atlas_coords[/code]. This value needs to be divided by the animation speed to get the actual animation loop duration.
</description>
</method>
<method name="get_tile_at_coords" qualifiers="const">
<return type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
If there is a tile covering the [code]atlas_coords[/code] coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns [code]Vector2i(-1, -1)[/code] otherwise.
</description>
</method>
<method name="get_tile_data" qualifiers="const">
<return type="TileData" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<description>
Returns the [TileData] object for the given atlas coordinates and alternative ID.
</description>
</method>
<method name="get_tile_size_in_atlas" qualifiers="const">
<return type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the size of the tile (in the grid coordinates system) at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="get_tile_texture_region" qualifiers="const">
<return type="Rect2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame" type="int" default="0" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame" type="int" default="0" />
<description>
Returns a tile's texture region in the atlas texture. For animated tiles, a [code]frame[/code] argument might be provided for the different frames of the animation.
</description>
</method>
<method name="get_tiles_to_be_removed_on_change">
<return type="PackedVector2Array" />
<argument index="0" name="texture" type="Texture2D" />
<argument index="1" name="margins" type="Vector2i" />
<argument index="2" name="separation" type="Vector2i" />
<argument index="3" name="texture_region_size" type="Vector2i" />
<param index="0" name="texture" type="Texture2D" />
<param index="1" name="margins" type="Vector2i" />
<param index="2" name="separation" type="Vector2i" />
<param index="3" name="texture_region_size" type="Vector2i" />
<description>
Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [code]texture[/code], [code]margins[/code], [code]separation[/code] or [code]texture_region_size[/code]. This can be used to undo changes that would have caused tiles data loss.
</description>
</method>
<method name="has_room_for_tile" qualifiers="const">
<return type="bool" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" />
<argument index="2" name="animation_columns" type="int" />
<argument index="3" name="animation_separation" type="Vector2i" />
<argument index="4" name="frames_count" type="int" />
<argument index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="animation_columns" type="int" />
<param index="3" name="animation_separation" type="Vector2i" />
<param index="4" name="frames_count" type="int" />
<param index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" />
<description>
Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [code]ignored_tile[/code] is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties.
</description>
</method>
<method name="move_tile_in_atlas">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
<description>
Move the tile and its alternatives at the [code]atlas_coords[/code] coordinates to the [code]new_atlas_coords[/code] coordinates with the [code]new_size[/code] size. This functions will fail if a tile is already present in the given area.
If [code]new_atlas_coords[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's coordinates. If [code]new_size[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's size.
@ -168,8 +168,8 @@
</method>
<method name="remove_alternative_tile">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<description>
Remove a tile's alternative with alternative ID [code]alternative_tile[/code].
Calling this function with [code]alternative_tile[/code] equals to 0 will fail, as the base tile alternative cannot be removed.
@ -177,16 +177,16 @@
</method>
<method name="remove_tile">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<description>
Remove a tile and its alternative at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="set_alternative_tile_id">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<argument index="2" name="new_id" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<param index="2" name="new_id" type="int" />
<description>
Change a tile's alternative ID from [code]alternative_tile[/code] to [code]new_id[/code].
Calling this function with [code]alternative_id[/code] equals to 0 will fail, as the base tile alternative cannot be moved.
@ -194,41 +194,41 @@
</method>
<method name="set_tile_animation_columns">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_columns" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_columns" type="int" />
<description>
Sets the number of columns in the animation layout of the tile at coordinates [code]atlas_coords[/code]. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas.
</description>
</method>
<method name="set_tile_animation_frame_duration">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_index" type="int" />
<argument index="2" name="duration" type="float" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_index" type="int" />
<param index="2" name="duration" type="float" />
<description>
Sets the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code].
</description>
</method>
<method name="set_tile_animation_frames_count">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frames_count" type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frames_count" type="int" />
<description>
Sets how many animation frames the tile at coordinates [code]atlas_coords[/code] has.
</description>
</method>
<method name="set_tile_animation_separation">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="separation" type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="separation" type="Vector2i" />
<description>
Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates [code]atlas_coords[/code] has.
</description>
</method>
<method name="set_tile_animation_speed">
<return type="void" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="speed" type="float" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="speed" type="float" />
<description>
Sets the animation speed of the tile at coordinates [code]atlas_coords[/code] has.
</description>