Class BreakPoint

Represents a break period in a beatmap.

Hierarchy

BreakPoint

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BreakPoint(values: { endTime: number; startTime: number }): BreakPoint

- Defined in osu-base/src/beatmap/timings/BreakPoint.ts:25
Parameters
- values: { endTime: number; startTime: number }
  - endTime: number
  - startTime: number
Returns BreakPoint

Properties

Readonly duration

duration: number

The duration of the break period. This is obtained from endTime - startTime.

Readonly endTime

endTime: number

The end time of the break period.

Readonly startTime

startTime: number

The start time of the break period.

Static Readonly MIN_BREAK_DURATION

MIN_BREAK_DURATION: number = 650

The minimum duration required for a break to have any effect.

Methods

contains

contains(time: number): boolean

- Defined in osu-base/src/beatmap/timings/BreakPoint.ts:44
Whether this break period contains a specified time.

Parameters
- time: number
  
  The time to check in milliseconds.
Returns boolean
Whether the time falls within this break period.

toString

toString(): string

- Defined in osu-base/src/beatmap/timings/BreakPoint.ts:34
Returns a string representation of the class.

Returns string

Generated using TypeDoc