Path2D

When set to true, the path forms a closed loop by connecting the last control point back to the first. The closure only takes effect when the path has at least 3 control points. Defaults to false.

Determines the stroke color used to render the Path2D. Defaults to [0, 0, 0] (black). A child UIGradient can override the solid color with a gradient fill.

The 1-based index of the currently selected control point. Defaults to 1 and is clamped to the range [1, number of control points]. Changing this value updates Path2D.SelectedControlPointData to reflect the control point at the new index.

A read-only computed property that returns the Path2DControlPoint at the index specified by Path2D.SelectedControlPoint. If the path has no control points, returns a default-constructed Path2DControlPoint (position and tangents all at {0, 0, 0, 0}).

Determines the stroke width of the Path2D in pixels. Defaults to 1 and is clamped to the range [0, 100].

Determines if the Path2D path is rendered or not. When false, the path will not render. However, any modifications to the control points will update correctly, ensuring that querying data will have the correct info.

Determines the order in which a Path2D path renders relative to other GUIs. Works the same as GuiObject.ZIndex but does not interact with layout order in any way.

Returns the Rect bounding size for the Path2D. This is computed based on the control points and is not modifiable outside of changing the control point data.

Returns the Path2DControlPoint for a given index. If the index is out of bounds, this method will throw an error.

Returns a table of all the Path2DControlPoints for the Path2D.

Returns the length of the Path2D. This function can be expensive if called too frequently.

Returns 100, the hard upper limit on the number of control points a Path2D can contain. Attempting to add points beyond this limit via Path2D:InsertControlPoint() or Path2D:SetControlPoints() throws an error.

Returns the 2D UDim2 position at a given t value between 0 and 1 (inclusive), representing the parameter space result of querying the spline. The values will be more tightly packed near bends and wider apart in straighter segments; see GetPositionOnCurveArcLength() for even spacing results.

Throws an error if the Path2D has less than two control points.

Returns the 2D UDim2 position at a given t value between 0 and 1 (inclusive), representing the arc length space result of querying the spline. The values will be evenly spaced along the spline; see GetPositionOnCurve() for parameter spacing results.

Throws an error if the Path2D has less than two control points.

Returns the tangent at a given t value in parameter space where t is a value between 0 and 1 (inclusive). Throws an error if the Path2D has less than two control points.

Returns the tangent at a given t value in arc length space where t is a value between 0 and 1 (inclusive). Throws an error if the Path2D has less than two control points.

Inserts a new Path2DControlPoint at a given index. Throws a warning if the index is out of bounds or if you're trying to add control points past the limit of 50.

Removes a control point at the given index. Throws a warning if the index is out of bounds.

Sets all the control points to the specified array, replacing all existing points with new ones. Throws a warning if there are more than 50 points in the controlPoints array.

Updates the control point at the given index. Throws a warning if the index is out of range.

Fires whenever the path's control-point data is mutated. This includes calls to Path2D:SetControlPoints(), Path2D:InsertControlPoint(), Path2D:UpdateControlPoint(), and Path2D:RemoveControlPoint(). Does not fire for changes to visual properties such as Path2D.Color3 or Path2D.Thickness.