# instrument_key

Instrument key datums contain everything needed to know how to play a specific note of an instrument.*

## Vars | |

deviation | Deviation up/down from the pivot point that uses its sample. Used to calculate frequency. |
---|---|

frequency | The frequency to play the sample to get our desired note. |

key | The numerical key of what this is, from 1 to 127 on a standard piano keyboard. |

sample | The actual sample file that will be loaded when playing. |

## Procs | |

calculate | Calculates and stores our deviation. |

## Var Details

### deviation

Deviation up/down from the pivot point that uses its sample. Used to calculate frequency.

### frequency

The frequency to play the sample to get our desired note.

### key

The numerical key of what this is, from 1 to 127 on a standard piano keyboard.

### sample

The actual sample file that will be loaded when playing.

## Proc Details

### calculate

Calculates and stores our deviation.