Give feedback when "terrain save-tile" is not successfully invoked.

3 files changed, 58 insertions, 30 deletions

diff --git a/OpenSim/Framework/RegionInfo.cs b/OpenSim/Framework/RegionInfo.cs
index 5ba3863..a505524 100644
--- a/OpenSim/Framework/RegionInfo.cs
+++ b/OpenSim/Framework/RegionInfo.cs
@@ -421,12 +421,18 @@ namespace OpenSim.Framework
             set { m_internalEndPoint = value; }
         }
 
+        /// <summary>
+        /// The x co-ordinate of this region in map tiles (e.g. 1000).
+        /// </summary>
         public uint RegionLocX
         {
             get { return m_regionLocX.Value; }
             set { m_regionLocX = value; }
         }
 
+        /// <summary>
+        /// The y co-ordinate of this region in map tiles (e.g. 1000).
+        /// </summary>
         public uint RegionLocY
         {
             get { return m_regionLocY.Value; }
diff --git a/OpenSim/Region/CoreModules/World/Terrain/ITerrainLoader.cs b/OpenSim/Region/CoreModules/World/Terrain/ITerrainLoader.cs
index 7237f90..d407617 100644
--- a/OpenSim/Region/CoreModules/World/Terrain/ITerrainLoader.cs
+++ b/OpenSim/Region/CoreModules/World/Terrain/ITerrainLoader.cs
@@ -38,6 +38,21 @@ namespace OpenSim.Region.CoreModules.World.Terrain
         ITerrainChannel LoadStream(Stream stream);
         void SaveFile(string filename, ITerrainChannel map);
         void SaveStream(Stream stream, ITerrainChannel map);
+
+        /// <summary>
+        /// Save a number of map tiles to a single big image file.
+        /// </summary>
+        /// <remarks>
+        /// If the image file already exists then the tiles saved will replace those already in the file - other tiles
+        /// will be untouched.
+        /// </remarks>
+        /// <param name="filename">The terrain file to save</param>
+        /// <param name="offsetX">The map x co-ordinate at which to begin the save.</param>
+        /// <param name="offsetY">The may y co-ordinate at which to begin the save.</param>
+        /// <param name="fileWidth">The number of tiles to save along the X axis.</param>
+        /// <param name="fileHeight">The number of tiles to save along the Y axis.</param>
+        /// <param name="regionSizeX">The width of a map tile.</param>
+        /// <param name="regionSizeY">The height of a map tile.</param>
         void SaveFile(ITerrainChannel map, string filename, int offsetX, int offsetY, int fileWidth, int fileHeight, int regionSizeX, int regionSizeY);
     }
 }
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/World/Terrain/TerrainModule.cs b/OpenSim/Region/CoreModules/World/Terrain/TerrainModule.cs
index 9cd8f2b..7c5ea29 100644
--- a/OpenSim/Region/CoreModules/World/Terrain/TerrainModule.cs
+++ b/OpenSim/Region/CoreModules/World/Terrain/TerrainModule.cs
@@ -561,49 +561,56 @@ namespace OpenSim.Region.CoreModules.World.Terrain
         }
 
         /// <summary>
-        /// Saves the terrain to a larger terrain file.
+        /// Save a number of map tiles to a single big image file.
         /// </summary>
+        /// <remarks>
+        /// If the image file already exists then the tiles saved will replace those already in the file - other tiles
+        /// will be untouched.
+        /// </remarks>
         /// <param name="filename">The terrain file to save</param>
-        /// <param name="fileWidth">The width of the file in units</param>
-        /// <param name="fileHeight">The height of the file in units</param>
-        /// <param name="fileStartX">Where to begin our slice</param>
-        /// <param name="fileStartY">Where to begin our slice</param>
+        /// <param name="fileWidth">The number of tiles to save along the X axis.</param>
+        /// <param name="fileHeight">The number of tiles to save along the Y axis.</param>
+        /// <param name="fileStartX">The map x co-ordinate at which to begin the save.</param>
+        /// <param name="fileStartY">The may y co-ordinate at which to begin the save.</param>
         public void SaveToFile(string filename, int fileWidth, int fileHeight, int fileStartX, int fileStartY)
         {
             int offsetX = (int)m_scene.RegionInfo.RegionLocX - fileStartX;
             int offsetY = (int)m_scene.RegionInfo.RegionLocY - fileStartY;
 
-            if (offsetX >= 0 && offsetX < fileWidth && offsetY >= 0 && offsetY < fileHeight)
+            if (offsetX < 0 || offsetX >= fileWidth || offsetY < 0 || offsetY >= fileHeight)
             {
-                // this region is included in the tile request
-                foreach (KeyValuePair<string, ITerrainLoader> loader in m_loaders)
+                MainConsole.Instance.OutputFormat(
+                    "ERROR: file width + minimum X tile and file height + minimum Y tile must incorporate the current region at ({0},{1}).  File width {2} from {3} and file height {4} from {5} does not.",
+                    m_scene.RegionInfo.RegionLocX, m_scene.RegionInfo.RegionLocY, fileWidth, fileStartX, fileHeight, fileStartY);
+
+                return;
+            }
+
+            // this region is included in the tile request
+            foreach (KeyValuePair<string, ITerrainLoader> loader in m_loaders)
+            {
+                if (filename.EndsWith(loader.Key))
                 {
-                    if (filename.EndsWith(loader.Key))
+                    lock (m_scene)
                     {
-                        lock (m_scene)
-                        {
-                            loader.Value.SaveFile(m_channel, filename, offsetX, offsetY,
-                                                  fileWidth, fileHeight,
-                                                  (int)Constants.RegionSize,
-                                                  (int)Constants.RegionSize);
-
-                            m_log.InfoFormat("[TERRAIN]: Saved terrain from {0} to {1}", m_scene.RegionInfo.RegionName, filename);
-                        }
-                        
-                        return;
+                        loader.Value.SaveFile(m_channel, filename, offsetX, offsetY,
+                                              fileWidth, fileHeight,
+                                              (int)Constants.RegionSize,
+                                              (int)Constants.RegionSize);
+
+                        MainConsole.Instance.OutputFormat(
+                            "Saved terrain from ({0},{1}) to ({2},{3}) from {4} to {5}",
+                            fileStartX, fileStartY, fileStartX + fileWidth - 1, fileStartY + fileHeight - 1,
+                            m_scene.RegionInfo.RegionName, filename);
                     }
+                    
+                    return;
                 }
-
-                m_log.ErrorFormat(
-                    "[TERRAIN]: Could not save terrain from {0} to {1}.  Valid file extensions are {2}",
-                    m_scene.RegionInfo.RegionName, filename, m_supportedFileExtensions);
             }
-//            else
-//            {
-//                m_log.ErrorFormat(
-//                    "[TERRAIN]: Could not save terrain from {0} to {1}.  {2} {3} {4} {5} {6} {7}",
-//                    m_scene.RegionInfo.RegionName, filename, fileWidth, fileHeight, fileStartX, fileStartY, offsetX, offsetY);
-//            }
+
+            MainConsole.Instance.OutputFormat(
+                "ERROR: Could not save terrain from {0} to {1}.  Valid file extensions are {2}",
+                m_scene.RegionInfo.RegionName, filename, m_supportedFileExtensions);
         }
 
         /// <summary>