Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

PolygonPathFinderΒΆ

Inherits: Resource < RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

MethodsΒΆ

PackedVector2Array

find_path(from: Vector2, to: Vector2)

Rect2

get_bounds() const

Vector2

get_closest_point(point: Vector2) const

PackedVector2Array

get_intersections(from: Vector2, to: Vector2) const

float

get_point_penalty(idx: int) const

bool

is_point_inside(point: Vector2) const

void

set_point_penalty(idx: int, penalty: float)

void

setup(points: PackedVector2Array, connections: PackedInt32Array)


Method DescriptionsΒΆ

PackedVector2Array find_path(from: Vector2, to: Vector2) πŸ”—

There is currently no description for this method. Please help us by contributing one!


Rect2 get_bounds() const πŸ”—

There is currently no description for this method. Please help us by contributing one!


Vector2 get_closest_point(point: Vector2) const πŸ”—

There is currently no description for this method. Please help us by contributing one!


PackedVector2Array get_intersections(from: Vector2, to: Vector2) const πŸ”—

There is currently no description for this method. Please help us by contributing one!


float get_point_penalty(idx: int) const πŸ”—

There is currently no description for this method. Please help us by contributing one!


bool is_point_inside(point: Vector2) const πŸ”—

Returns true if point falls inside the polygon area.

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

void set_point_penalty(idx: int, penalty: float) πŸ”—

There is currently no description for this method. Please help us by contributing one!


void setup(points: PackedVector2Array, connections: PackedInt32Array) πŸ”—

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 connections must be even, returns an error if odd.

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)