Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add descriptions to PolygonPathFinder setup and is_point_inside methods

Browse Source
This commit is contained in:
andrei-g99 2024-08-19 02:56:47 +03:00 committed by Rémi Verschelde
parent 514c564a8c
commit 61ddf05eef
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
doc/classes/PolygonPathFinder.xml
View File

@ -42,6 +42,30 @@
<return type="bool" /> <return type="bool" />
<param index="0" name="point" type="Vector2" /> <param index="0" name="point" type="Vector2" />
<description> <description>
Returns [code]true[/code] if [param point] falls inside the polygon area.
[codeblocks]
[gdscript]
var polygon_path_finder = PolygonPathFinder.new()
var points = [Vector2(0.0, 0.0), Vector2(1.0, 0.0), Vector2(0.0, 1.0)]
var connections = [0, 1, 1, 2, 2, 0]
polygon_path_finder.setup(points, connections)
print(polygon_path_finder.is_point_inside(Vector2(0.2, 0.2))) # Prints true
print(polygon_path_finder.is_point_inside(Vector2(1.0, 1.0))) # Prints false
[/gdscript]
[csharp]
var polygonPathFinder = new PolygonPathFinder();
var points = new Vector2[]
{
new Vector2(0.0f, 0.0f),
new Vector2(1.0f, 0.0f),
new Vector2(0.0f, 1.0f)
};
var connections = new int[] { 0, 1, 1, 2, 2, 0 };
polygonPathFinder.Setup(points, connections);
GD.Print(polygonPathFinder.IsPointInside(new Vector2(0.2f, 0.2f))); // Prints true
GD.Print(polygonPathFinder.IsPointInside(new Vector2(1.0f, 1.0f))); // Prints false
[/csharp]
[/codeblocks]
</description> </description>
</method> </method>
<method name="set_point_penalty"> <method name="set_point_penalty">
@ -56,6 +80,27 @@
<param index="0" name="points" type="PackedVector2Array" /> <param index="0" name="points" type="PackedVector2Array" />
<param index="1" name="connections" type="PackedInt32Array" /> <param index="1" name="connections" type="PackedInt32Array" />
<description> <description>
Sets up [PolygonPathFinder] with an array of points that define the vertices of the polygon, and an array of indices that determine the edges of the polygon.
The length of [param connections] must be even, returns an error if odd.
[codeblocks]
[gdscript]
var polygon_path_finder = PolygonPathFinder.new()
var points = [Vector2(0.0, 0.0), Vector2(1.0, 0.0), Vector2(0.0, 1.0)]
var connections = [0, 1, 1, 2, 2, 0]
polygon_path_finder.setup(points, connections)
[/gdscript]
[csharp]
var polygonPathFinder = new PolygonPathFinder();
var points = new Vector2[]
{
new Vector2(0.0f, 0.0f),
new Vector2(1.0f, 0.0f),
new Vector2(0.0f, 1.0f)
};
var connections = new int[] { 0, 1, 1, 2, 2, 0 };
polygonPathFinder.Setup(points, connections);
[/csharp]
[/codeblocks]
</description> </description>
</method> </method>
</methods> </methods>