minor: Add doc to ScenePresence.IsInTransit to make it clear that this is set only for region crossing and not teleport, etc.

user_profiles
Justin Clark-Casey (justincc) 2013-02-22 23:08:14 +00:00
parent ccb7cce819
commit a93f06eb88
1 changed files with 6 additions and 0 deletions

View File

@ -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; }