Skip to content
ClassTweens & Motion@public

FlxPath

Mutable path data followed by a FlxObject.

ts
export declare class FlxPath

Constructors

ts
constructor(nodes?: FlxPoint[] | null)

Constructs a new instance of the FlxPath class

ParameterTypeDescription
nodesFlxPoint[] | null-

Properties

PropertyModifiersTypeDescription
debugColor-number-
debugScrollFactor-FlxPoint-
ignoreDrawDebug-boolean-
managerstatic readonlyDebugPathDisplay | null-
nodes-FlxPoint[]-

Methods

add()

ts
add(x: number, y: number): void

Parameters:

ParameterTypeDescription
xnumber-
ynumber-

Returns: void

addAt()

ts
addAt(x: number, y: number, index: number): void

Parameters:

ParameterTypeDescription
xnumber-
ynumber-
indexnumber-

Returns: void

addPoint()

ts
addPoint(node: FlxPoint, asReference?: boolean): void

Parameters:

ParameterTypeDescription
nodeFlxPoint-
asReferenceboolean-

Returns: void

addPointAt()

ts
addPointAt(node: FlxPoint, index: number, asReference?: boolean): void

Parameters:

ParameterTypeDescription
nodeFlxPoint-
indexnumber-
asReferenceboolean-

Returns: void

destroy()

ts
destroy(): void

Returns: void

ts
head(): FlxPoint | null

Returns: FlxPoint | null

remove()

ts
remove(node: FlxPoint): FlxPoint | null

Parameters:

ParameterTypeDescription
nodeFlxPoint-

Returns: FlxPoint | null

removeAt()

ts
removeAt(index: number): FlxPoint | null

Parameters:

ParameterTypeDescription
indexnumber-

Returns: FlxPoint | null

tail()

ts
tail(): FlxPoint | null

Returns: FlxPoint | null

Released under the MIT License.