From fd8a7e64b90aa02897ff145d527e96e98936d3ca Mon Sep 17 00:00:00 2001
From: SignpostMarv
Date: Tue, 11 Sep 2012 20:01:00 +0100
Subject: documentation (OnTerrainTick)

---
 OpenSim/Region/Framework/Scenes/EventManager.cs | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'OpenSim/Region/Framework/Scenes/EventManager.cs')

diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index b2960e7..6dc8865 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -81,6 +81,13 @@ namespace OpenSim.Region.Framework.Scenes
 
         public delegate void OnTerrainTickDelegate();
 
+        /// <summary>
+        /// Triggered if the terrain has been edited
+        /// </summary>
+        /// <remarks>
+        /// This gets triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.UpdateTerrain"/>
+        /// but is used by core solely to update the physics engine.
+        /// </remarks>
         public event OnTerrainTickDelegate OnTerrainTick;
 
         public delegate void OnBackupDelegate(ISimulationDataService datastore, bool forceBackup);
-- 
cgit v1.1