From ca3ea849d808b7f184cb05c42c317ed19edb73fc Mon Sep 17 00:00:00 2001
From: Filippos Karapetis
Date: Sat, 9 Jun 2012 16:29:14 +0300
Subject: SCI: Update information on kGetSierraProfileInt

Thanks to LePhilousophe for his feedback and observations on this
---
 engines/sci/engine/kmisc.cpp | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'engines')

diff --git a/engines/sci/engine/kmisc.cpp b/engines/sci/engine/kmisc.cpp
index 9a113bc5f9..f243cf2ffe 100644
--- a/engines/sci/engine/kmisc.cpp
+++ b/engines/sci/engine/kmisc.cpp
@@ -391,6 +391,8 @@ reg_t kGetConfig(EngineState *s, int argc, reg_t *argv) {
 	return argv[1];
 }
 
+// Likely modelled after the Windows 3.1 function GetPrivateProfileInt:
+// http://msdn.microsoft.com/en-us/library/windows/desktop/ms724345%28v=vs.85%29.aspx
 reg_t kGetSierraProfileInt(EngineState *s, int argc, reg_t *argv) {
 	Common::String category = s->_segMan->getString(argv[0]);	// always "config"
 	category.toLowercase();
@@ -402,8 +404,7 @@ reg_t kGetSierraProfileInt(EngineState *s, int argc, reg_t *argv) {
 	if (setting != "videospeed")
 		error("GetSierraProfileInt: setting isn't 'videospeed', it's '%s'", setting.c_str());
 
-	// The game scripts pass 425 as the third parameter for some unknown reason,
-	// as after the call they compare the result to 425 anyway...
+	// The third parameter is 425 (the default if the configuration key is missing)
 
 	// We return the same fake value for videospeed as with kGetConfig
 	return make_reg(0, 500);
-- 
cgit v1.2.3