mirror of
https://github.com/godotengine/godot.git
synced 2026-01-03 18:11:19 +03:00
[doc] Use "param" instead of "code" to refer to parameters
This commit is contained in:
Andy Maloney
Yuri Sizov
@@ -19,7 +19,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<description>
|
||||
Returns the one-way margin (for one-way platforms) of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Returns the one-way margin (for one-way platforms) of the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_polygon_points" qualifiers="const">
|
||||
@@ -27,14 +27,14 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<description>
|
||||
Returns the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Returns the points of the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_polygons_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<description>
|
||||
Returns how many polygons the tile has for TileSet physics layer with index [code]layer_id[/code].
|
||||
Returns how many polygons the tile has for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_constant_angular_velocity" qualifiers="const">
|
||||
@@ -55,35 +55,35 @@
|
||||
<return type="Variant" />
|
||||
<param index="0" name="layer_name" type="String" />
|
||||
<description>
|
||||
Returns the custom data value for custom data layer named [code]layer_name[/code].
|
||||
Returns the custom data value for custom data layer named [param layer_name].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_custom_data_by_layer_id" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<description>
|
||||
Returns the custom data value for custom data layer with index [code]layer_id[/code].
|
||||
Returns the custom data value for custom data layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_polygon" qualifiers="const">
|
||||
<return type="NavigationPolygon" />
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<description>
|
||||
Returns the navigation polygon of the tile for the TileSet navigation layer with index [code]layer_id[/code].
|
||||
Returns the navigation polygon of the tile for the TileSet navigation layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_occluder" qualifiers="const">
|
||||
<return type="OccluderPolygon2D" />
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<description>
|
||||
Returns the occluder polygon of the tile for the TileSet occlusion layer with index [code]layer_id[/code].
|
||||
Returns the occluder polygon of the tile for the TileSet occlusion layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_terrain_peering_bit" qualifiers="const">
|
||||
<return type="int" />
|
||||
<param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" />
|
||||
<description>
|
||||
Returns the tile's terrain bit for the given [code]peering_bit[/code] direction.
|
||||
Returns the tile's terrain bit for the given [param peering_bit] direction.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_collision_polygon_one_way" qualifiers="const">
|
||||
@@ -91,7 +91,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<description>
|
||||
Returns whether one-way collisions are enabled for the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Returns whether one-way collisions are enabled for the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_collision_polygon">
|
||||
@@ -99,7 +99,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<description>
|
||||
Removes the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Removes the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_polygon_one_way">
|
||||
@@ -108,7 +108,7 @@
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<param index="2" name="one_way" type="bool" />
|
||||
<description>
|
||||
Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Enables/disables one-way collisions on the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_polygon_one_way_margin">
|
||||
@@ -117,7 +117,7 @@
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<param index="2" name="one_way_margin" type="float" />
|
||||
<description>
|
||||
Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Enables/disables one-way collisions on the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_polygon_points">
|
||||
@@ -126,7 +126,7 @@
|
||||
<param index="1" name="polygon_index" type="int" />
|
||||
<param index="2" name="polygon" type="PackedVector2Array" />
|
||||
<description>
|
||||
Sets the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
|
||||
Sets the points of the polygon at index [param polygon_index] for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_polygons_count">
|
||||
@@ -134,7 +134,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="polygons_count" type="int" />
|
||||
<description>
|
||||
Sets the polygons count for TileSet physics layer with index [code]layer_id[/code].
|
||||
Sets the polygons count for TileSet physics layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constant_angular_velocity">
|
||||
@@ -158,7 +158,7 @@
|
||||
<param index="0" name="layer_name" type="String" />
|
||||
<param index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the tile's custom data value for the TileSet custom data layer with name [code]layer_name[/code].
|
||||
Sets the tile's custom data value for the TileSet custom data layer with name [param layer_name].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_custom_data_by_layer_id">
|
||||
@@ -166,7 +166,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the tile's custom data value for the TileSet custom data layer with index [code]layer_id[/code].
|
||||
Sets the tile's custom data value for the TileSet custom data layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation_polygon">
|
||||
@@ -174,7 +174,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="navigation_polygon" type="NavigationPolygon" />
|
||||
<description>
|
||||
Sets the navigation polygon for the TileSet navigation layer with index [code]layer_id[/code].
|
||||
Sets the navigation polygon for the TileSet navigation layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_occluder">
|
||||
@@ -182,7 +182,7 @@
|
||||
<param index="0" name="layer_id" type="int" />
|
||||
<param index="1" name="occluder_polygon" type="OccluderPolygon2D" />
|
||||
<description>
|
||||
Sets the occluder for the TileSet occlusion layer with index [code]layer_id[/code].
|
||||
Sets the occluder for the TileSet occlusion layer with index [param layer_id].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_terrain_peering_bit">
|
||||
@@ -190,7 +190,7 @@
|
||||
<param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" />
|
||||
<param index="1" name="terrain" type="int" />
|
||||
<description>
|
||||
Sets the tile's terrain bit for the given [code]peering_bit[/code] direction.
|
||||
Sets the tile's terrain bit for the given [param peering_bit] direction.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
Reference in New Issue
Block a user