Class EffectControlPoint

Represents a control point that applies an effect to a beatmap.

Hierarchy

<internal>.ControlPoint
- EffectControlPoint

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EffectControlPoint(values: { isKiai: boolean; omitFirstBarLine: boolean; time: number }): EffectControlPoint

Overrides ControlPoint.constructor
- Defined in osu-base/src/beatmap/timings/EffectControlPoint.ts:17
Parameters
- values: { isKiai: boolean; omitFirstBarLine: boolean; time: number }
  - isKiai: boolean
  - omitFirstBarLine: boolean
  - time: number
Returns EffectControlPoint

Properties

Readonly isKiai

isKiai: boolean

Whether or not kiai time is enabled at this control point.

Readonly omitFirstBarLine

omitFirstBarLine: boolean

Whether the first bar line of this control point is ignored.

Readonly time

time: number

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

Methods

isRedundant

isRedundant(existing: EffectControlPoint): boolean

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

Parameters
- existing: EffectControlPoint
Returns boolean

toString

toString(): string

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

Returns string

Generated using TypeDoc