Class HingeCFrameTrack

Track for movement along a rotational axis.

Hierarchy

CFrameTrack
- HingeCFrameTrack

Index

Constructors

Properties

axis isCircuited length name origin useDegrees useNegativeAngle

Methods

clampToLength getCFrame getPositionOffsetCFrames hasPassedEnd fromInstance

Constructors

constructor

new HingeCFrameTrack(axis: Axis, origin?: CFrame, useNegativeAngle?: boolean, useDegrees?: boolean): HingeCFrameTrack
Parameters
- axis: Axis
- Optional origin: CFrame
- Optional useNegativeAngle: boolean
- Optional useDegrees: boolean
Returns HingeCFrameTrack
Overrides CFrameTrack.constructor
- Defined in src/cframeTrack/hinge.ts:34

Properties

axis

axis: Axis

isCircuited

isCircuited: boolean

length

length: number

name

name: string

origin

origin: CFrame

useDegrees

useDegrees: boolean

useNegativeAngle

useNegativeAngle: boolean

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/hinge.ts:103

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<HingeCFrameTrack, string>
Parameters
- this: void
- instance: Instance
Returns Result<HingeCFrameTrack, string>
Overrides CFrameTrack.fromInstance
- Defined in src/cframeTrack/hinge.ts:49

Generated using TypeDoc