From 6c451c9cf481dcaa6261c34773b79689386ded42 Mon Sep 17 00:00:00 2001
From: Filippos Karapetis
Date: Thu, 25 Dec 2014 21:48:59 +0200
Subject: ZVISION: Document where MIDI commands are used

---
 engines/zvision/scripting/actions.cpp         | 4 +++-
 engines/zvision/scripting/sidefx/music_node.h | 1 +
 2 files changed, 4 insertions(+), 1 deletion(-)

(limited to 'engines')

diff --git a/engines/zvision/scripting/actions.cpp b/engines/zvision/scripting/actions.cpp
index 89b311e81c..be2079736e 100644
--- a/engines/zvision/scripting/actions.cpp
+++ b/engines/zvision/scripting/actions.cpp
@@ -477,7 +477,9 @@ ActionMusic::ActionMusic(ZVision *engine, int32 slotkey, const Common::String &l
 
 	sscanf(line.c_str(), "%u %24s %u %u", &type, fileNameBuffer, &loop, &volume);
 
-	// type 4 are midi sound effect files
+	// Type 4 actions are MIDI commands, not files. These are only used by
+	// Zork: Nemesis, for the flute and piano puzzles (tj4e and ve6f, as well
+	// as vr)
 	if (type == 4) {
 		_midi = true;
 		int note;
diff --git a/engines/zvision/scripting/sidefx/music_node.h b/engines/zvision/scripting/sidefx/music_node.h
index 8f4a46f3fc..3f1ca5cf7b 100644
--- a/engines/zvision/scripting/sidefx/music_node.h
+++ b/engines/zvision/scripting/sidefx/music_node.h
@@ -91,6 +91,7 @@ private:
 	bool _loaded;
 };
 
+// Only used by Zork: Nemesis, for the flute and piano puzzles (tj4e and ve6f, as well as vr)
 class MusicMidiNode : public MusicNodeBASE {
 public:
 	MusicMidiNode(ZVision *engine, uint32 key, int8 program, int8 note, int8 volume);
-- 
cgit v1.2.3