Path2D | Documentation - Roblox Creator Hub

Engine Class

Path2D

Summary

Properties

Closed:boolean

Color3:Color3

SelectedControlPoint:number

SelectedControlPointData:Path2DControlPoint

Thickness:number

Visible:boolean

ZIndex:number

Methods

GetBoundingRect():Rect

GetControlPoint(index: number):Path2DControlPoint

GetControlPoints():{any}

GetLength():number

GetMaxControlPoints():number

GetPositionOnCurve(t: number):UDim2

GetPositionOnCurveArcLength(t: number):UDim2

GetTangentOnCurve(t: number):Vector2

GetTangentOnCurveArcLength(t: number):Vector2

InsertControlPoint(index: number,point: Path2DControlPoint):()

RemoveControlPoint(index: number):()

SetControlPoints(controlPoints: {any}):()

UpdateControlPoint(index: number,point: Path2DControlPoint):()

Events

ControlPointChanged():RBXScriptSignal

Inherited Members

57 inherited from Instance

6 inherited from Object

API Reference

Properties

Closed

Read Parallel

Capabilities: UI

Path2D.Closed:boolean

Color3

Read Parallel

Capabilities: UI

Path2D.Color3:Color3

SelectedControlPoint

Not Replicated

Roblox Script Security

Read Parallel

Capabilities: UI

Path2D.SelectedControlPoint:number

SelectedControlPointData

Not Replicated

Roblox Script Security

Read Parallel

Capabilities: UI

Path2D.SelectedControlPointData:Path2DControlPoint

Thickness

Read Parallel

Capabilities: UI

Path2D.Thickness:number

Visible

Read Parallel

Capabilities: UI

Path2D.Visible:boolean

ZIndex

Read Parallel

Capabilities: UI

Path2D.ZIndex:number

Methods

GetBoundingRect

Capabilities: UI

Path2D:GetBoundingRect():Rect

Returns

Rect

GetControlPoint

Capabilities: UI

Path2D:GetControlPoint(index:number):Path2DControlPoint

Parameters

index:number

Returns

Path2DControlPoint

GetControlPoints

Capabilities: UI

Path2D:GetControlPoints():{any}

Returns

{any}

GetLength

Capabilities: UI

Path2D:GetLength():number

Returns

number

GetMaxControlPoints

Capabilities: UI

Path2D:GetMaxControlPoints():number

Returns

number

GetPositionOnCurve

Capabilities: UI

Path2D:GetPositionOnCurve(t:number):UDim2

Parameters

t:number

Returns

UDim2

GetPositionOnCurveArcLength

Capabilities: UI

Path2D:GetPositionOnCurveArcLength(t:number):UDim2

Parameters

t:number

Returns

UDim2

GetTangentOnCurve

Capabilities: UI

Path2D:GetTangentOnCurve(t:number):Vector2

Parameters

t:number

Returns

Vector2

GetTangentOnCurveArcLength

Capabilities: UI

Path2D:GetTangentOnCurveArcLength(t:number):Vector2

Parameters

t:number

Returns

Vector2

InsertControlPoint

Capabilities: UI

Path2D:InsertControlPoint(

index:number, point:Path2DControlPoint

):()

Parameters

index:number

point:Path2DControlPoint

Returns

()

RemoveControlPoint

Capabilities: UI

Path2D:RemoveControlPoint(index:number):()

Parameters

index:number

Returns

()

SetControlPoints

Capabilities: UI

Path2D:SetControlPoints(controlPoints:{any}):()

Parameters

controlPoints:{any}

Returns

()

UpdateControlPoint

Capabilities: UI

Path2D:UpdateControlPoint(

index:number, point:Path2DControlPoint

):()

Parameters

index:number

point:Path2DControlPoint

Returns

()

Events

ControlPointChanged

Capabilities: UI

Path2D.ControlPointChanged():RBXScriptSignal