minor: add doc to a few parcel methods

5 files changed, 44 insertions, 7 deletions

diff --git a/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestPreparation.cs b/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestPreparation.cs
index f08d8ec..71bfe57 100644
--- a/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestPreparation.cs
+++ b/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestPreparation.cs
@@ -93,6 +93,16 @@ namespace OpenSim.Region.CoreModules.World.Archiver
             List<EntityBase> entities = m_scene.GetEntities();
             List<SceneObjectGroup> sceneObjects = new List<SceneObjectGroup>();
 
+            /*
+                foreach (ILandObject lo in m_scene.LandChannel.AllParcels())
+                {
+                    if (name == lo.LandData.Name)
+                    {
+                        // This is the parcel we want
+                    }
+                }
+                */
+     
             // Filter entities so that we only have scene objects.
             // FIXME: Would be nicer to have this as a proper list in SceneGraph, since lots of methods
             // end up having to do this
diff --git a/OpenSim/Region/CoreModules/World/Land/LandChannel.cs b/OpenSim/Region/CoreModules/World/Land/LandChannel.cs
index 4ed23bb..81024db 100644
--- a/OpenSim/Region/CoreModules/World/Land/LandChannel.cs
+++ b/OpenSim/Region/CoreModules/World/Land/LandChannel.cs
@@ -105,7 +105,7 @@ namespace OpenSim.Region.CoreModules.World.Land
             ILandObject obj = new LandObject(UUID.Zero, false, m_scene);
             obj.LandData.Name = "NO LAND";
             return obj;
-        }
+        }      
 
         public List<ILandObject> AllParcels()
         {
@@ -154,6 +154,7 @@ namespace OpenSim.Region.CoreModules.World.Land
                 m_landManagementModule.UpdateLandObject(localID, data);
             }
         }
+        
         public void ReturnObjectsInParcel(int localID, uint returnType, UUID[] agentIDs, UUID[] taskIDs, IClientAPI remoteClient)
         {
             if (m_landManagementModule != null)
diff --git a/OpenSim/Region/CoreModules/World/Land/LandManagementModule.cs b/OpenSim/Region/CoreModules/World/Land/LandManagementModule.cs
index 968f46a..9a2ef50 100644
--- a/OpenSim/Region/CoreModules/World/Land/LandManagementModule.cs
+++ b/OpenSim/Region/CoreModules/World/Land/LandManagementModule.cs
@@ -67,7 +67,14 @@ namespace OpenSim.Region.CoreModules.World.Land
         private const int landArrayMax = ((int)((int)Constants.RegionSize / 4) >= 64) ? (int)((int)Constants.RegionSize / 4) : 64;
         #pragma warning restore 0429
 
+        /// <value>
+        /// Local land ids at specified region co-ordinates (region size / 4) 
+        /// </value>
         private readonly int[,] m_landIDList = new int[landArrayMax, landArrayMax];
+
+        /// <value>
+        /// Land objects keyed by local id 
+        /// </value>
         private readonly Dictionary<int, ILandObject> m_landList = new Dictionary<int, ILandObject>();
 
         private bool m_landPrimCountTainted;
@@ -570,6 +577,7 @@ namespace OpenSim.Region.CoreModules.World.Land
 
             if (x_float > Constants.RegionSize || x_float <= 0 || y_float > Constants.RegionSize || y_float <= 0)
                 return null;
+            
             try
             {
                 x = Convert.ToInt32(Math.Floor(Convert.ToDouble(x_float) / 4.0));
@@ -584,6 +592,7 @@ namespace OpenSim.Region.CoreModules.World.Land
             {
                 return null;
             }
+            
             lock (m_landList)
             {
                 // Corner case. If an autoreturn happens during sim startup
@@ -603,6 +612,7 @@ namespace OpenSim.Region.CoreModules.World.Land
                 // they happen every time at border crossings
                 throw new Exception("Error: Parcel not found at point " + x + ", " + y);
             }
+            
             lock (m_landIDList)
             {
                 try
@@ -617,7 +627,7 @@ namespace OpenSim.Region.CoreModules.World.Land
                     return null;
                 }
             }
-        }
+        }      
 
         #endregion
 
diff --git a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
index 74f404f..6fe6118 100644
--- a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
+++ b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs
@@ -33,26 +33,41 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface ILandChannel
     {
-        List<ILandObject> ParcelsNearPoint(Vector3 position);
+        /// <summary>
+        /// Get all parcels
+        /// </summary>
+        /// <returns></returns>
         List<ILandObject> AllParcels();
              
         /// <summary>
-        /// Get the land object at the specified point
+        /// Get the parcel at the specified point
         /// </summary>
         /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
         /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
         /// <returns>Land object at the point supplied</returns>
         ILandObject GetLandObject(int x, int y);
 
-        ILandObject GetLandObject(int localID);
-
         /// <summary>
-        /// Get the land object at the specified point
+        /// Get the parcel at the specified point
         /// </summary>
         /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
         /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
         /// <returns>Land object at the point supplied</returns>
         ILandObject GetLandObject(float x, float y);
+
+        /// <summary>
+        /// Get the parcels near the specified point
+        /// </summary>
+        /// <param name="position"></param>
+        /// <returns></returns>
+        List<ILandObject> ParcelsNearPoint(Vector3 position);        
+
+        /// <summary>
+        /// Get the parcel given the land's local id.
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <returns></returns>
+        ILandObject GetLandObject(int localID);
         
         bool IsLandPrimCountTainted();
         bool IsForcefulBansAllowed();
diff --git a/OpenSim/Region/RegionCombinerModule/RegionCombinerLargeLandChannel.cs b/OpenSim/Region/RegionCombinerModule/RegionCombinerLargeLandChannel.cs
index 146ec66..9da818a 100644
--- a/OpenSim/Region/RegionCombinerModule/RegionCombinerLargeLandChannel.cs
+++ b/OpenSim/Region/RegionCombinerModule/RegionCombinerLargeLandChannel.cs
@@ -118,6 +118,7 @@ public class RegionCombinerLargeLandChannel : ILandChannel
                         return regionData.RegionScene.LandChannel.GetLandObject(x - offsetX, y - offsetY);
                     }
                 }
+                
                 ILandObject obj = new LandObject(UUID.Zero, false, RegData.RegionScene);
                 obj.LandData.Name = "NO LAND";
                 return obj;