Class SampleControlPoint

Represents a control point that handles sample sounds.

Hierarchy

<internal>.ControlPoint
- SampleControlPoint

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SampleControlPoint(values: { customSampleBank: number; sampleBank: SampleBank; sampleVolume: number; time: number }): SampleControlPoint

Overrides ControlPoint.constructor
- Defined in osu-base/src/beatmap/timings/SampleControlPoint.ts:25
Parameters
- values: { customSampleBank: number; sampleBank: SampleBank; sampleVolume: number; time: number }
  - customSampleBank: number
  - sampleBank: SampleBank
  - sampleVolume: number
  - time: number
Returns SampleControlPoint

Properties

Readonly customSampleBank

customSampleBank: number

The index of the sample bank, if this sample bank uses custom samples.

If this is 0, the beatmap's sample should be used instead.

Readonly sampleBank

sampleBank: SampleBank

The sample bank at this control point.

Readonly sampleVolume

sampleVolume: number

The sample volume at this control point.

Readonly time

time: number

The time at which the control point takes effect in milliseconds.

Methods

isRedundant

isRedundant(existing: SampleControlPoint): boolean

Overrides ControlPoint.isRedundant
- Defined in osu-base/src/beatmap/timings/SampleControlPoint.ts:38
Determines whether this control point results in a meaningful change when placed alongside another.

Parameters
- existing: SampleControlPoint
Returns boolean

toString

toString(): string

Overrides ControlPoint.toString
- Defined in osu-base/src/beatmap/timings/SampleControlPoint.ts:46
Returns a string representative of the class.

Returns string

Generated using TypeDoc