Class MinecraftInstrument

Hierarchy (View Summary)

Instrument
- MinecraftInstrument

Index

Methods

checkMutable makeImmutable toId

Accessors

DEFAULT_IMMUTABLE DEFAULT_KEY DEFAULT_NAME DEFAULT_PRESS_KEY DEFAULT_SOUND_FILE DEFAULT_SUPPORTED_VERSION doesPressKey identifier isImmutable key name soundFile supportedVersion

Constructors

Methods

checkMutable

checkMutable(): Result
Returns Result
- Defined in src/instruments/MinecraftInstrument.ts:86

makeImmutable

makeImmutable(): void
Returns void
- Defined in src/instruments/MinecraftInstrument.ts:82

toId

toId(): number
Returns number
- Defined in src/instruments/MinecraftInstrument.ts:90

Accessors

`Static`DEFAULT_IMMUTABLE

get DEFAULT_IMMUTABLE(): boolean
Returns boolean
- Defined in src/instruments/MinecraftInstrument.ts:29

`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

`Static`DEFAULT_SUPPORTED_VERSION

get DEFAULT_SUPPORTED_VERSION(): 0 | 1 | 2 | 3 | 4 | 5 | 6
Returns 0 | 1 | 2 | 3 | 4 | 5 | 6
- Defined in src/instruments/MinecraftInstrument.ts:25

doesPressKey

get doesPressKey(): boolean
Returns boolean
Inherited from InitializedInstrument.doesPressKey
- Defined in src/instruments/Instrument.ts:78
set doesPressKey(pressKey: boolean): void
Parameters
- pressKey: boolean
Returns void
Inherited from InitializedInstrument.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

isImmutable

get isImmutable(): boolean
Returns boolean
- Defined in src/instruments/MinecraftInstrument.ts:78

key

get key(): KeyRange
Returns KeyRange
Overrides InitializedInstrument.key
- Defined in src/instruments/MinecraftInstrument.ts:56
set key(key: UnknownKeyRange): void
Parameters
- key: UnknownKeyRange
Returns void
Overrides InitializedInstrument.key
- Defined in src/instruments/MinecraftInstrument.ts:60

name

get name(): OptionalInstrumentName
Returns OptionalInstrumentName
Overrides InitializedInstrument.name
- Defined in src/instruments/MinecraftInstrument.ts:36
set name(name: OptionalInstrumentName): void
Parameters
- name: OptionalInstrumentName
Returns void
Overrides InitializedInstrument.name
- Defined in src/instruments/MinecraftInstrument.ts:40

soundFile

get soundFile(): OptionalInstrumentSoundFile
Returns OptionalInstrumentSoundFile
Overrides InitializedInstrument.soundFile
- Defined in src/instruments/MinecraftInstrument.ts:46
set soundFile(soundFile: OptionalInstrumentSoundFile): void
Parameters
- soundFile: OptionalInstrumentSoundFile
Returns void
Overrides InitializedInstrument.soundFile
- Defined in src/instruments/MinecraftInstrument.ts:50

supportedVersion

get supportedVersion(): 0 | 1 | 2 | 3 | 4 | 5 | 6
Returns 0 | 1 | 2 | 3 | 4 | 5 | 6
- Defined in src/instruments/MinecraftInstrument.ts:66
set supportedVersion(supportedVersion: UnknownSupportedVersionRange): void
Parameters
- supportedVersion: UnknownSupportedVersionRange
Returns void
- Defined in src/instruments/MinecraftInstrument.ts:70

Constructors

constructor

new MinecraftInstrument(identifier: ResourceLocation): MinecraftInstrument
Parameters
- identifier: ResourceLocation
Returns MinecraftInstrument
Inherited from Instrument.constructor
- Defined in src/instruments/Instrument.ts:44