[Scummvm-git-logs] scummvm master -> d66aff96c741f4c1f16ae10883970332f400175b

[djsrv]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
d66aff96c7 DIRECTOR: Clarify purpose of getPlatformEncoding


Commit: d66aff96c741f4c1f16ae10883970332f400175b
    https://github.com/scummvm/scummvm/commit/d66aff96c741f4c1f16ae10883970332f400175b
Author: djsrv (dservilla at gmail.com)
Date: 2021-11-08T23:44:08-05:00

Commit Message:
DIRECTOR: Clarify purpose of getPlatformEncoding

Changed paths:
    engines/director/cast.cpp
    engines/director/cast.h
    engines/director/director.cpp


diff --git a/engines/director/cast.cpp b/engines/director/cast.cpp
index 95e3faf8d4..cddf52f111 100644
--- a/engines/director/cast.cpp
+++ b/engines/director/cast.cpp
@@ -1252,12 +1252,14 @@ void Cast::loadCastInfo(Common::SeekableReadStreamEndian &stream, uint16 id) {
 	_castsInfo[id] = ci;
 }
 
-Common::CodePage Cast::getPlatformEncoding() {
+Common::CodePage Cast::getFileEncoding() {
+	// Returns the default encoding for the file this cast is contained in.
+	// This depends on which platform the file was made on.
 	return getEncoding(_platform, _vm->getLanguage());
 }
 
 Common::U32String Cast::decodeString(const Common::String &str) {
-	Common::CodePage encoding = getPlatformEncoding();
+	Common::CodePage encoding = getFileEncoding();
 
 	Common::String fixedStr;
 	if (encoding == Common::kWindows1252) {
diff --git a/engines/director/cast.h b/engines/director/cast.h
index c5d1baf971..6f0c7c5d41 100644
--- a/engines/director/cast.h
+++ b/engines/director/cast.h
@@ -105,7 +105,7 @@ public:
 	void dumpScript(const char *script, ScriptType type, uint16 id);
 	PaletteV4 loadPalette(Common::SeekableReadStreamEndian &stream);
 
-	Common::CodePage getPlatformEncoding();
+	Common::CodePage getFileEncoding();
 	Common::U32String decodeString(const Common::String &str);
 
 private:
diff --git a/engines/director/director.cpp b/engines/director/director.cpp
index ab626f6304..52e56c9290 100644
--- a/engines/director/director.cpp
+++ b/engines/director/director.cpp
@@ -243,6 +243,8 @@ Common::Error DirectorEngine::run() {
 }
 
 Common::CodePage DirectorEngine::getPlatformEncoding() {
+	// Returns the default encoding for the platform we're pretending to be.
+	// (English Mac OS, Japanese Mac OS, English Windows, etc.)
 	return getEncoding(getPlatform(), getLanguage());
 }