summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJimB16 <f1@jimb.de>2015-11-11 23:06:20 +0100
committerJimB16 <f1@jimb.de>2015-11-11 23:06:20 +0100
commit5f87b62399dd4ba4844ef4cd65be8940b6f364e6 (patch)
tree6feaf78d6c4aa2fdae82be69ee767d32599e3415
parentdfe3cf2b12423b4a13d12568e2cf93d50d81918e (diff)
Updated Sound Engine Commands (markdown)
-rw-r--r--Sound-Engine-Commands.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/Sound-Engine-Commands.md b/Sound-Engine-Commands.md
index b2e4fc2..85a94a2 100644
--- a/Sound-Engine-Commands.md
+++ b/Sound-Engine-Commands.md
@@ -26,7 +26,7 @@ db $d8, (\1), (\2 << 4) | (\3 << 3) | (\4)
Sets the note length and (if we're not in channel 4) the volume envelope setting (see the command 'volenvelope') for the following notes.
The note length shouldn't be greater than 16, because it gets multiplied with the note duration (which is set with the note command, i.e. C_, 12) and of the result only the lower 8-Bits are taken into further calculation.
-# $d9: forceoctave byte (or setabsnote)
+# $d9: forceoctave byte (or setabsnote, transpose, key)
\1: octave (0 - 15)
\2: pitch (0 - 15)
db $d9, (\1 << 4) | (\2)
@@ -58,7 +58,7 @@ You also have to set the note length with the Cmd 'notetype', which corresponds
0.882 frames per tick * 256 = ~226
170 bpm = tempo 226
-# $db: dutycycle byte (or setwaveduty)
+# $db: dutycycle byte (or waveduty)
\1: Wave pattern duty setting (0-3)
db $db, (\1)
* usage:
@@ -158,14 +158,14 @@ db $e1, \1, (\2 << 4) | \3
Parameter is saved into the channel structure, but never used again.
The command is also never used by any song or sound effect.
-# $e3: togglenoise byte (or setdrumkit)
+# $e3: togglenoise byte (or drumkittoggle)
\1:
db $e3, (\1)
* usage:
* togglenoise $05
The command is used for channel 4 to set the drumkit and with it the available drumsounds.
-If noise sampling is off (is the initial state) then it gets turned on, if noise sampling is on it gets turned off and no drumkit is set.
+If noise sampling is off (the initial state) then it gets turned on, if noise sampling is on it gets turned off and no drumkit is set.
The Cmd is only used once per song in PokeCrystal so it's only used to set the drumkit.
# $e4: panning byte
@@ -205,7 +205,7 @@ parameter is directly written in hardware register [NR50](http://bgb.bircd.org/p
in the cartridge to supply a fifth sound channel, additionally to the gameboys
internal four channels. As far as I know this feature isn't used by any existing games.
-# $e6: tone word (setpitchoffset)
+# $e6: tone word (pitchoffset)
\1: 11bit frequency
db $e6
dw (\1)
@@ -254,11 +254,11 @@ db $ef, (\1)
The command is only executed if stereo is activated in the options and then it acts the same as Cmd $e4.
-# $f0: sfxtogglenoise byte (or setsfxdrumkit)
+# $f0: sfxtogglenoise byte (or sfxdrumkittoggle)
\1:
db $f0, (\1)
* usage:
- * sfxtogglenoise $05
+ * sfxtogglenoise $4
Does the same as Cmd $e3 just for the SFX Channel.
@@ -271,11 +271,11 @@ db $f9
Sets a flag which is never used.
-# $fa: setcondition byte
-\1: condition
+# $fa: condition byte
+\1: conditionbyte
db $fa, \1
* usage:
- * setcondition condition
+ * condition conditionbyte
Sets the condition read by Cmd $fb.
@@ -316,4 +316,3 @@ dw (\1)
Command ends the music stream.
When this command is encountered with subroutine flag set, we return to caller of the subroutine.
- \ No newline at end of file