--- doc/docbase/instrument_scripts/nksp/reference/functions/nksp_same_region_function.html 2017/05/28 15:22:55 3229 +++ doc/docbase/instrument_scripts/nksp/reference/functions/nksp_same_region_function.html 2017/05/28 15:29:35 3230 @@ -8,9 +8,9 @@

same_region()

The key range (or note range if you will) of instruments is assigned to - one more multiple keyboard regions. So each "region" is responsible for + one or more keyboard regions. So each "region" is responsible for mapping audio samples and synthesis parameters for a certain key range. - This function takes two keys on the keyboard (as MIDI note numbers) as + This function takes two keys on the keyboard (as MIDI note number) as arguments and checks the region relationship of the two keys, that is if the two keys have a region mapped each, and if yes how the relationship of those two regions exactly is. So the result value of this function depends on the @@ -31,13 +31,13 @@ ??key1?? Integer Number - Note number.
+ Note number of 1st key to be checked.
[required] ??key2?? Integer Number - Note number.
+ Note number of 2nd key to be checked.
[required] @@ -49,13 +49,13 @@ Relationship of the two keys:
- 0: Both keys have a region, however they are two different + 0: Both keys have a region, however they are two different regions, which also and don't overlap each other.
- 1: Both keys have a region and it is exactly the same region.
- 2: Both keys have a region, which are two different regions, they are overlapping each other though.
- 3: ??key1?? has a region, ??key2?? does not have any region.
- 4: ??key1?? does not have any region, ??key2?? has a region.
- 5: ??key1?? and ??key2?? both don't have any region. + 1: Both keys have a region and it is exactly the same region.
+ 2: Both keys have a region, which are two different regions, and which are overlapping each other though.
+ 3: ??key1?? has a region, ??key2?? does not have any region.
+ 4: ??key1?? does not have any region, ??key2?? has a region.
+ 5: ??key1?? and ??key2?? both don't have any region. Integer Number