From a93f06eb88489f822d903249377ce8cbdd991fb0 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 22 Feb 2013 23:08:14 +0000
Subject: minor: Add doc to ScenePresence.IsInTransit to make it clear that
 this is set only for region crossing and not teleport, etc.

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

(limited to 'OpenSim/Region/Framework')

diff --git a/OpenSim/Region/Framework/Scenes/ScenePresence.cs b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
index 9c1d2b6..39a885c 100644
--- a/OpenSim/Region/Framework/Scenes/ScenePresence.cs
+++ b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
@@ -657,6 +657,12 @@ namespace OpenSim.Region.Framework.Scenes
 
         private bool m_inTransit;
 
+        /// <summary>
+        /// This signals whether the presence is in transit between neighbouring regions.
+        /// </summary>
+        /// <remarks> 
+        /// It is not set when the presence is teleporting or logging in/out directly to a region.
+        /// </remarks>
         public bool IsInTransit
         {
             get { return m_inTransit; }
-- 
cgit v1.1