Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HitSampleInfo

Represents a gameplay hit sample.

Hierarchy

  • HitSampleInfo

Index

Constructors

Properties

Accessors

Constructors

constructor

  • Parameters

    • name: string
    • Optional bank: <internal>.SampleBank
    • Optional customSampleBank: number
    • Optional volume: number
    • Optional isLayered: boolean

    Returns <internal>.HitSampleInfo

Properties

Optional Readonly bank

bank?: <internal>.SampleBank

The bank to load the sample from.

Readonly customSampleBank

customSampleBank: number

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

If this is 0, the control point's sample index should be used instead.

Readonly isLayered

isLayered: boolean

Whether this hit sample is layered.

Layered hit sample are automatically added in all modes (except osu!mania), but can be disabled using the layered skin config option.

Readonly name

name: string

The name of the sample.

Readonly volume

volume: number

The sample volume.

If this is 0, the control point's volume should be used instead.

Static Readonly HIT_CLAP

HIT_CLAP: string

Static Readonly HIT_FINISH

HIT_FINISH: string

Static Readonly HIT_NORMAL

HIT_NORMAL: string

Static Readonly HIT_WHISTLE

HIT_WHISTLE: string

Accessors

isCustom

  • get isCustom(): boolean

  • Whether this hit sample is a custom sample.

    Returns boolean

Generated using TypeDoc