From fcbe7b9ed63eb4a64a241113421125c3ecf844b8 Mon Sep 17 00:00:00 2001
From: Adam Frisby
Date: Sat, 4 Apr 2009 05:51:26 +0000
Subject: * Drops Heightmap.Get/Heightmap.Set from IHeightmap interface. * Adds
 Heightmap[x,y] to interface. * MRM Scripts should utilize
 World.Heightmap[x,y] = 0.0; to replace set, and Val = World.Heightmap[x,y] to
 get.

---
 .../Scripting/Minimodule/IHeightmap.cs              | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'OpenSim/Region/OptionalModules/Scripting/Minimodule/IHeightmap.cs')

diff --git a/OpenSim/Region/OptionalModules/Scripting/Minimodule/IHeightmap.cs b/OpenSim/Region/OptionalModules/Scripting/Minimodule/IHeightmap.cs
index 37cf8ae..afea12b 100644
--- a/OpenSim/Region/OptionalModules/Scripting/Minimodule/IHeightmap.cs
+++ b/OpenSim/Region/OptionalModules/Scripting/Minimodule/IHeightmap.cs
@@ -33,9 +33,26 @@ namespace OpenSim.Region.OptionalModules.Scripting.Minimodule
 {
     public interface IHeightmap
     {
+        /// <summary>
+        /// Returns [or sets] the heightmap value at specified coordinates.
+        /// </summary>
+        /// <param name="x">X Coordinate</param>
+        /// <param name="y">Y Coordinate</param>
+        /// <returns>A value in meters representing height. Can be negative. Value correlates with Z parameter in world coordinates</returns>
+        double this[int x, int y]
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// The maximum height of the region (Y axis), exclusive. (eg Height = 256, max Y = 255). Minimum is always 0 inclusive.
+        /// </summary>
         int Height { get; }
+
+        /// <summary>
+        /// The maximum width of the region (X axis), exclusive. (eg Width = 256, max X = 255). Minimum is always 0 inclusive.
+        /// </summary>
         int Width { get; }
-        double Get(int x, int y);
-        void Set(int x, int y, double val);
     }
 }
-- 
cgit v1.1