diff options
Diffstat (limited to 'doc/classes/AStar.xml')
| -rw-r--r-- | doc/classes/AStar.xml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 0c7de55329..99e2db6d83 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -47,7 +47,7 @@ var as = AStar.new() as.add_point(1, Vector3(1, 0, 0), 4) # Adds the point (1, 0, 0) with weight_scale 4 and id 1 [/codeblock] - If there already exists a point for the given id, its position and weight scale are updated to the given values. + If there already exists a point for the given [code]id[/code], its position and weight scale are updated to the given values. </description> </method> <method name="are_points_connected" qualifiers="const"> @@ -102,7 +102,7 @@ <return type="int"> </return> <description> - Returns the next available point id with no point associated to it. + Returns the next available point ID with no point associated to it. </description> </method> <method name="get_closest_point" qualifiers="const"> @@ -111,7 +111,7 @@ <argument index="0" name="to_position" type="Vector3"> </argument> <description> - Returns the id of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. + Returns the ID of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool. </description> </method> <method name="get_closest_position_in_segment" qualifiers="const"> @@ -126,7 +126,7 @@ as.add_point(1, Vector3(0, 0, 0)) as.add_point(2, Vector3(0, 5, 0)) as.connect_points(1, 2) - var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # returns (0, 3, 0) + var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # Returns (0, 3, 0) [/codeblock] The result is in the segment that goes from [code]y = 0[/code] to [code]y = 5[/code]. It's the closest position in the segment to the given point. </description> @@ -139,11 +139,11 @@ <argument index="1" name="to_id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. + Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] var as = AStar.new() as.add_point(1, Vector3(0, 0, 0)) - as.add_point(2, Vector3(0, 1, 0), 1) # default weight is 1 + as.add_point(2, Vector3(0, 1, 0), 1) # Default weight is 1 as.add_point(3, Vector3(1, 1, 0)) as.add_point(4, Vector3(2, 0, 0)) @@ -153,7 +153,7 @@ as.connect_points(1, 4, false) as.connect_points(5, 4, false) - var res = as.get_id_path(1, 3) # returns [1, 2, 3] + var res = as.get_id_path(1, 3) # Returns [1, 2, 3] [/codeblock] If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> @@ -164,7 +164,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns an array with the ids of the points that form the connect with the given point. + Returns an array with the IDs of the points that form the connection with the given point. [codeblock] var as = AStar.new() as.add_point(1, Vector3(0, 0, 0)) @@ -175,7 +175,7 @@ as.connect_points(1, 2, true) as.connect_points(1, 3, true) - var neighbors = as.get_point_connections(1) # returns [2, 3] + var neighbors = as.get_point_connections(1) # Returns [2, 3] [/codeblock] </description> </method> @@ -196,7 +196,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the position of the point associated with the given id. + Returns the position of the point associated with the given [code]id[/code]. </description> </method> <method name="get_point_weight_scale" qualifiers="const"> @@ -205,7 +205,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns the weight scale of the point associated with the given id. + Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> <method name="get_points"> @@ -221,7 +221,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Returns whether a point associated with the given id exists. + Returns whether a point associated with the given [code]id[/code] exists. </description> </method> <method name="is_point_disabled" qualifiers="const"> @@ -239,7 +239,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes the point associated with the given id from the points pool. + Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> <method name="set_point_disabled"> @@ -261,7 +261,7 @@ <argument index="1" name="position" type="Vector3"> </argument> <description> - Sets the position for the point with the given id. + Sets the [code]position[/code] for the point with the given [code]id[/code]. </description> </method> <method name="set_point_weight_scale"> @@ -272,7 +272,7 @@ <argument index="1" name="weight_scale" type="float"> </argument> <description> - Sets the [code]weight_scale[/code] for the point with the given id. + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. </description> </method> </methods> |