Class NoteBuilder

constructor

• new NoteBuilder(
      chart: RpeJson,
      lineIndex: number,
      noteIndex: number,
  ): NoteBuilder

  Parameters

  • chart: RpeJson
  • lineIndex: number
  • noteIndex: number

  Returns NoteBuilder

Readonlychart

ReadonlylineIndex

ReadonlynoteIndex

data

• get data(): Note

  The raw Note object. Mutations are applied to the chart directly.

  Returns Note

setType

• setType(type: 1 | 2 | 3 | 4): this

  Set note type (1=Tap, 2=Hold, 3=Flick, 4=Drag).

  Parameters

  • type: 1 | 2 | 3 | 4

  Returns this

setX

• setX(x: number): this

  Set the X position.

  Parameters

  • x: number

  Returns this

moveX

• moveX(dx: number): this

  Translate the X position by dx.

  Parameters

  • dx: number

  Returns this

mirrorX

• mirrorX(): this

  Mirror the X position.

  Returns this

setSide

• setSide(side: 1 | 2): this

  Set which side of the line the note is on (1 = above, 2 = below).

  Parameters

  • side: 1 | 2

  Returns this

flipSide

• flipSide(): this

  Flip the note to the other side.

  Returns this

setSpeed

• setSpeed(speed: number): this

  Set the note speed multiplier.

  Parameters

  • speed: number

  Returns this

scaleSpeed

• scaleSpeed(factor: number): this

  Scale the note speed by a factor.

  Parameters

  • factor: number

  Returns this

setSize

• setSize(size: number): this

  Set the visual size multiplier.

  Parameters

  • size: number

  Returns this

scaleSize

• scaleSize(factor: number): this

  Scale the note size by a factor.

  Parameters

  • factor: number

  Returns this

setAlpha

• setAlpha(alpha: number): this

  Set the opacity (0–255).

  Parameters

  • alpha: number

  Returns this

setFake

• setFake(fake: boolean): this

  Set whether the note is fake (non-scoring).

  Parameters

  • fake: boolean

  Returns this

setYOffset

• setYOffset(y: number): this

  Set the Y offset.

  Parameters

  • y: number

  Returns this

setJudgeArea

• setJudgeArea(size: number): this

  Set the judge area multiplier (RPE standard hitbox multiplier).

  Parameters

  • size: number

  Returns this

setJudgeSize

• setJudgeSize(size: number | undefined): this

  Set the explicit judge size (PhiZone Player extension). Overrides judgeArea when present. Pass undefined to remove it.

  Parameters

  • size: number | undefined

  Returns this

setZIndex

• setZIndex(z: number | undefined): this

  Set the Z-index rendering override. Pass undefined to remove it.

  Parameters

  • z: number | undefined

  Returns this

setZIndexHitEffects

• setZIndexHitEffects(z: number | undefined): this

  Set the Z-index for the hit-effect sprites. Pass undefined to remove it.

  Parameters

  • z: number | undefined

  Returns this

setStartBeat

• setStartBeat(beat: number): this

  Set the note's start beat. Also shifts the end beat for hold notes if they would become invalid.

  Parameters

  • beat: number

  Returns this

setEndBeat

• setEndBeat(beat: number): this

  Set the note's end beat (only meaningful for Hold notes, type=2). Must be >= the note's start beat.

  Parameters

  • beat: number

  Returns this

setVisibleTime

• setVisibleTime(time: number): this

  Set the visible time (beats before hit that the note appears).

  Parameters

  • time: number

  Returns this

setHitsound

• setHitsound(hitsound: string): this

  Set a custom hitsound.

  Parameters

  • hitsound: string

  Returns this

setTint

• setTint(color: [number, number, number] | null): this

  Set the tint color [r, g, b] or null to clear.

  Parameters

  • color: [number, number, number] | null

  Returns this

setTintHitEffects

• setTintHitEffects(color: [number, number, number] | null): this

  Set the hit-effects tint color [r, g, b] or null to clear.

  Parameters

  • color: [number, number, number] | null

  Returns this

offsetBeat

• offsetBeat(beatOffset: number): this

  Move the note's start beat by beatOffset. For hold notes, the end beat is also shifted by the same amount.

  Parameters

  • beatOffset: number

  Returns this

setHoldDuration

• setHoldDuration(durationBeats: number): this

  Set the hold duration in beats (only meaningful for type-2 hold notes). The end beat is calculated as startBeat + duration.

  Parameters

  • durationBeats: number

  Returns this

remove

• remove(): Note | undefined

  Remove this note from its line. After calling this, the builder is invalidated — do not call further methods.

  Returns Note | undefined

  The removed Note data.

toLine

• toLine(): LineBuilder

  Navigate back to the containing LineBuilder.

  Returns LineBuilder

toChart

• toChart(): ChartBuilder

  Navigate back to a ChartBuilder.

  Returns ChartBuilder