Class InitializedInstrument

Hierarchy (View Summary)

Instrument
- InitializedInstrument

Index

Methods

Accessors

DEFAULT_KEY DEFAULT_NAME DEFAULT_PRESS_KEY DEFAULT_SOUND_FILE doesPressKey identifier key name soundFile

Constructors

Methods

`Static`from

from(song: Song, instrument: Instrument): InitializedInstrument
Parameters
- song: Song
- instrument: Instrument
Returns InitializedInstrument
- Defined in src/instruments/InitializedInstrument.ts:17

toId

toId(): number
Returns number
- Defined in src/instruments/InitializedInstrument.ts:28

Accessors

`Static`DEFAULT_KEY

get DEFAULT_KEY(): KeyRange
Returns KeyRange
Inherited from Instrument.DEFAULT_KEY
- Defined in src/instruments/Instrument.ts:29

`Static`DEFAULT_NAME

get DEFAULT_NAME(): OptionalInstrumentName
Returns OptionalInstrumentName
Inherited from Instrument.DEFAULT_NAME
- Defined in src/instruments/Instrument.ts:21

`Static`DEFAULT_PRESS_KEY

get DEFAULT_PRESS_KEY(): boolean
Returns boolean
Inherited from Instrument.DEFAULT_PRESS_KEY
- Defined in src/instruments/Instrument.ts:33

`Static`DEFAULT_SOUND_FILE

get DEFAULT_SOUND_FILE(): OptionalInstrumentSoundFile
Returns OptionalInstrumentSoundFile
Inherited from Instrument.DEFAULT_SOUND_FILE
- Defined in src/instruments/Instrument.ts:25

doesPressKey

get doesPressKey(): boolean
Returns boolean
Inherited from Instrument.doesPressKey
- Defined in src/instruments/Instrument.ts:78
set doesPressKey(pressKey: boolean): void
Parameters
- pressKey: boolean
Returns void
Inherited from Instrument.doesPressKey
- Defined in src/instruments/Instrument.ts:82

identifier

get identifier(): ResourceLocation
Returns ResourceLocation
Inherited from Instrument.identifier
- Defined in src/instruments/Instrument.ts:48

key

get key(): KeyRange
Returns KeyRange
Inherited from Instrument.key
- Defined in src/instruments/Instrument.ts:68
set key(key: UnknownKeyRange): void
Parameters
- key: UnknownKeyRange
Returns void
Inherited from Instrument.key
- Defined in src/instruments/Instrument.ts:72

name

get name(): OptionalInstrumentName
Returns OptionalInstrumentName
Inherited from Instrument.name
- Defined in src/instruments/Instrument.ts:52
set name(name: OptionalInstrumentName): void
Parameters
- name: OptionalInstrumentName
Returns void
Inherited from Instrument.name
- Defined in src/instruments/Instrument.ts:56

soundFile

get soundFile(): OptionalInstrumentSoundFile
Returns OptionalInstrumentSoundFile
Inherited from Instrument.soundFile
- Defined in src/instruments/Instrument.ts:60
set soundFile(soundFile: OptionalInstrumentSoundFile): void
Parameters
- soundFile: OptionalInstrumentSoundFile
Returns void
Inherited from Instrument.soundFile
- Defined in src/instruments/Instrument.ts:64

Constructors

constructor

new InitializedInstrument(
song: Song,
identifier: ResourceLocation,
): InitializedInstrument
Parameters
- song: Song
- identifier: ResourceLocation
Returns InitializedInstrument
Overrides Instrument.constructor
- Defined in src/instruments/InitializedInstrument.ts:11