Class SingleTypeSection

Defines the TrackTypes for a given section.

See isInSection for more info about the start and end positions

Hierarchy

TypeSection
- SingleTypeSection

Index

Constructors

Properties

endPosition startPosition trackType

Methods

clone getTrackType isInSection default fromInstance

Constructors

constructor

new SingleTypeSection(startPos: number, endPos: number, trackType: TrackType): SingleTypeSection
Default constructor
Parameters
- startPos: number
- endPos: number
- trackType: TrackType
Returns SingleTypeSection
Overrides TypeSection.constructor
- Defined in src/physicsSimulator/trackSectionsData/typeSection/singleTypeSection.ts:22

Properties

endPosition

endPosition: number

startPosition

startPosition: number

trackType

trackType: TrackType

Methods

clone

clone(): SingleTypeSection
Returns SingleTypeSection
Overrides TypeSection.clone
- Defined in src/physicsSimulator/trackSectionsData/typeSection/singleTypeSection.ts:66

getTrackType

getTrackType(_t: number): undefined | TrackType
Gets the TrackType for this section using the given time value

Returns
Parameters
- _t: number
  
  Time spent in this section
Returns undefined | TrackType
Overrides TypeSection.getTrackType
- Defined in src/physicsSimulator/trackSectionsData/typeSection/singleTypeSection.ts:76

isInSection

isInSection(position: number, direction: boolean): boolean
Returns true if the given position is in this section determined by the following ranges:

If direction is true: - If start < end - range is [start, end)
- If start > end
  - range is [start, inf) (-inf, end)
If direction is false:
- If start < end
  - range is (start, end]
- If start > end
  - range is (start, inf) (-inf, end]
Returns
Parameters
- position: number
- direction: boolean
Returns boolean
Inherited from TypeSection.isInSection
- Defined in src/physicsSimulator/trackSectionsData/typeSection/typeSection.ts:80

`Static` default

default(this: void): TypeSection
Constructs a TypeSection whose range is between [0 and math.huge]
Parameters
- this: void
  
  Denotes function as static. Do not include in Lua code
Returns TypeSection
Inherited from TypeSection.default
- Defined in src/physicsSimulator/trackSectionsData/typeSection/typeSection.ts:25

`Static` fromInstance

fromInstance(this: void, instance: Instance): Result<SingleTypeSection, string>
Constructs a TypeSection from an Instance

Returns
Parameters
- this: void
  
  Denotes function as static. Do not include in Lua code
- instance: Instance
Returns Result<SingleTypeSection, string>
Overrides TypeSection.fromInstance
- Defined in src/physicsSimulator/trackSectionsData/typeSection/singleTypeSection.ts:34

Generated using TypeDoc