Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HitObject Abstract

Represents a hitobject in a beatmap.

Hierarchy

  • HitObject

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • values: { comboOffset?: number; endPosition?: <internal>.Vector2; endTime?: number; newCombo?: boolean; position: <internal>.Vector2; startTime: number; type?: number }
      • Optional comboOffset?: number
      • Optional endPosition?: <internal>.Vector2
      • Optional endTime?: number
      • Optional newCombo?: boolean
      • position: <internal>.Vector2
      • startTime: number
      • Optional type?: number

    Returns <internal>.HitObject

Properties

Readonly comboOffset

comboOffset: number

How many combo colors to skip, if this object starts a new combo.

Readonly endPosition

endPosition: <internal>.Vector2

The end position of the hitobject in osu!pixels.

endTime

endTime: number

The end time of the hitobject.

Readonly isNewCombo

isNewCombo: boolean

Whether this hit object represents a new combo.

Readonly position

position: <internal>.Vector2

The position of the hitobject in osu!pixels.

samples

samples: <internal>.HitSampleInfo[]

The samples to be played when this hit object is hit.

In the case of sliders, this is the sample of the curve body and can be treated as the default samples for the hit object.

scale

scale: number

The scale used to calculate stacked position and radius.

stackHeight

stackHeight: number

The stack height of the hitobject.

startTime

startTime: number

The start time of the hitobject in milliseconds.

Readonly type

type: <internal>.objectTypes

The bitwise type of the hitobject (circle/slider/spinner).

Accessors

duration

  • get duration(): number

  • The duration of the hitobject.

    Returns number

radius

  • get radius(): number

  • The radius of the hitobject.

    Returns number

stackOffset

  • The stack vector to calculate offset for stacked positions.

    Returns <internal>.Vector2

stackedEndPosition

  • The stacked end position of the hitobject.

    Returns <internal>.Vector2

stackedPosition

  • The stacked position of the hitobject.

    Returns <internal>.Vector2

Methods

Abstract toString

  • toString(): string

  • Returns the string representative of the class.

    Returns string

typeStr

  • typeStr(): string

  • Returns the hitobject type.

    Returns string

Generated using TypeDoc