From b34e776e517b893d3cc140e7282a99026c2500f8 Mon Sep 17 00:00:00 2001
From: md5
Date: Sun, 15 May 2011 11:25:46 +0300
Subject: SWORD25 (LUA): Clarified the use of os_remove()

---
 engines/sword25/util/lua/loslib.cpp | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'engines/sword25')

diff --git a/engines/sword25/util/lua/loslib.cpp b/engines/sword25/util/lua/loslib.cpp
index 51266b522f..de96860812 100644
--- a/engines/sword25/util/lua/loslib.cpp
+++ b/engines/sword25/util/lua/loslib.cpp
@@ -26,8 +26,11 @@ static int os_execute (lua_State *L) {
 
 
 static int os_remove (lua_State *L) {
-  // Removed in ScummVM, does nothing. It's called when loading games (perhaps
-  // to delete the savegame thumbnail?)
+  // Non-portable call that deletes a file. Removed in ScummVM.
+  // This call is invoked in sword25 when loading games in order to remove the
+  // temporary savegame thumbnail that the original engine code created. We
+  // embed the thumbnail in the savegame instead, so this call is not needed at
+  // all.
   return 1;
 }
 
-- 
cgit v1.2.3