instrument

Instrument datums hold the data for any given instrument, as well as data on how to play it and what bounds there are to playing it.

The datums themselves are kept in SSinstruments in a list by their unique ID. The reason it uses ID instead of typepath is to support the runtime creation of instruments. Since songs cache them while playing, there isn't realistic issues regarding performance from accessing.

Vars
HIGHEST_KEY	Don't touch this
LOWEST_KEY	Don't touch this x2
abstract_type	Used for categorization subtypes
admin_only	Oh no - For truly troll instruments.
category	Category
id	Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead.
instrument_flags	See __DEFINES/flags/instruments.dm
legacy_instrument_ext	For legacy instruments, our file extension
legacy_instrument_path	For legacy instruments, the path to our notes
name	Name of the instrument
real_samples	Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127
samples	assoc list key = /datum/instrument_key. do not fill this yourself!
songs_using	What songs are using us
volume_multiplier	Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing)
Procs
Initialize	Initializes the instrument, calculating its samples if necessary.
calculate_samples	For synthesized instruments, this is how the instrument generates the "keys" that a /datum/song uses to play notes. Calculating them on the fly would be unperformant, so we do it during init and keep it all cached in a list.
is_ready	Checks if this instrument is ready to play.

Var Details

var
HIGHEST_KEY
– /static

Don't touch this

var
LOWEST_KEY
– /static

Don't touch this x2

var
abstract_type
–

Used for categorization subtypes

var
admin_only
–

Oh no - For truly troll instruments.

var
category
–

var
id
–

Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead.

var
instrument_flags
–

See __DEFINES/flags/instruments.dm

var
legacy_instrument_ext
–

For legacy instruments, our file extension

var
legacy_instrument_path
–

For legacy instruments, the path to our notes

var
name
–

Name of the instrument

var
real_samples
– /list

Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127

var
samples
– /list

assoc list key = /datum/instrument_key. do not fill this yourself!

var
songs_using
– /list/datum/song

What songs are using us

var
volume_multiplier
–

Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing)

Proc Details

proc
Initialize
()

Initializes the instrument, calculating its samples if necessary.

proc
calculate_samples
()

For synthesized instruments, this is how the instrument generates the "keys" that a /datum/song uses to play notes. Calculating them on the fly would be unperformant, so we do it during init and keep it all cached in a list.

proc
is_ready
()

Checks if this instrument is ready to play.

Instrument Datums /datum/instrument

Vars

Procs

Var Details

var HIGHEST_KEY – /static

var LOWEST_KEY – /static

var abstract_type –

var admin_only –

var category –

var id –

var instrument_flags –

var legacy_instrument_ext –

var legacy_instrument_path –

var name –

var real_samples – /list

var samples – /list

var songs_using – /list/datum/song

var volume_multiplier –