Class TweenedPointsCFrameTrack

Defines a CFrameTrack. Returns a CFrame in world space based on a 1-dimensional value (Track Position)

Hierarchy

CFrameTrack
- TweenedPointsCFrameTrack

Index

Constructors

Properties

circuitRemainder hasher isCircuited length lengthWithoutCircuitRemainder name

Methods

clampToLength getCFrame getPositionOffsetCFrames hasPassedEnd fromInstance

Constructors

constructor

new TweenedPointsCFrameTrack(points: TweenedPointsData[], hashInterval?: number, isCircuited?: boolean): TweenedPointsCFrameTrack
Parameters
- points: TweenedPointsData[]
- Optional hashInterval: number
- Optional isCircuited: boolean
Returns TweenedPointsCFrameTrack
Overrides CFrameTrack.constructor
- Defined in src/cframeTrack/tweenedPoints.ts:87

Properties

circuitRemainder

circuitRemainder: number

hasher

hasher: TrackDataHasher<TweenedPointsData>

isCircuited

isCircuited: boolean

length

length: number

lengthWithoutCircuitRemainder

lengthWithoutCircuitRemainder: number

name

name: string

Methods

clampToLength

clampToLength(position: number): number
Parameters
- position: number
Returns number
Inherited from CFrameTrack.clampToLength
- Defined in src/cframeTrack/cframeTrack.ts:26

getCFrame

getCFrame(position: number): CFrame
Returns a CFrame in world space based on a 1-dimensional value (Track Position)

Returns
CFrame
Parameters
- position: number
  
  A 1-D value used to get the 3D value
Returns CFrame
Overrides CFrameTrack.getCFrame
- Defined in src/cframeTrack/tweenedPoints.ts:159

getPositionOffsetCFrames

getPositionOffsetCFrames(position: number, positionOffsets: number[]): CFrame[]
Parameters
- position: number
- positionOffsets: number[]
Returns CFrame[]
Inherited from CFrameTrack.getPositionOffsetCFrames
- Defined in src/cframeTrack/cframeTrack.ts:43

hasPassedEnd

hasPassedEnd(position: number): LuaTuple<[Option<boolean>, number]>
Parameters
- position: number
Returns LuaTuple<[Option<boolean>, number]>
Inherited from CFrameTrack.hasPassedEnd
- Defined in src/cframeTrack/cframeTrack.ts:30

`Static` fromInstance

fromInstance(this: void, instance: Instance): Result<TweenedPointsCFrameTrack, string>
Instance constructor

Returns
Result
Parameters
- this: void
  
  void
- instance: Instance
  
  Instance data. (See docs for more info)
Returns Result<TweenedPointsCFrameTrack, string>
Overrides CFrameTrack.fromInstance
- Defined in src/cframeTrack/tweenedPoints.ts:116

Generated using TypeDoc