diff options
author | Justin Clark-Casey (justincc) | 2011-02-18 21:19:16 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2011-02-18 21:19:16 +0000 |
commit | e774679f62dc0de54c1926b1b4a611ca317d2bd7 (patch) | |
tree | 922dd300a52af468d1f6523a02000454f4f2966e /OpenSim/Region/Framework/Scenes | |
parent | Stop the avatar sometimes pausing for more than a second on the border when r... (diff) | |
download | opensim-SC-e774679f62dc0de54c1926b1b4a611ca317d2bd7.zip opensim-SC-e774679f62dc0de54c1926b1b4a611ca317d2bd7.tar.gz opensim-SC-e774679f62dc0de54c1926b1b4a611ca317d2bd7.tar.bz2 opensim-SC-e774679f62dc0de54c1926b1b4a611ca317d2bd7.tar.xz |
minor: add method doc to a few ScenePresence methods
Diffstat (limited to 'OpenSim/Region/Framework/Scenes')
-rw-r--r-- | OpenSim/Region/Framework/Scenes/ScenePresence.cs | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/OpenSim/Region/Framework/Scenes/ScenePresence.cs b/OpenSim/Region/Framework/Scenes/ScenePresence.cs index 4150f4a..b47ec3c 100644 --- a/OpenSim/Region/Framework/Scenes/ScenePresence.cs +++ b/OpenSim/Region/Framework/Scenes/ScenePresence.cs | |||
@@ -2652,8 +2652,11 @@ namespace OpenSim.Region.Framework.Scenes | |||
2652 | #region Border Crossing Methods | 2652 | #region Border Crossing Methods |
2653 | 2653 | ||
2654 | /// <summary> | 2654 | /// <summary> |
2655 | /// Checks to see if the avatar is in range of a border and calls CrossToNewRegion | 2655 | /// Starts the process of moving an avatar into another region if they are crossing the border. |
2656 | /// </summary> | 2656 | /// </summary> |
2657 | /// <remarks> | ||
2658 | /// Also removes the avatar from the physical scene if transit has started. | ||
2659 | /// </remarks> | ||
2657 | protected void CheckForBorderCrossing() | 2660 | protected void CheckForBorderCrossing() |
2658 | { | 2661 | { |
2659 | if (IsChildAgent) | 2662 | if (IsChildAgent) |
@@ -2721,7 +2724,6 @@ namespace OpenSim.Region.Framework.Scenes | |||
2721 | neighbor = HaveNeighbor(Cardinals.N, ref fix); | 2724 | neighbor = HaveNeighbor(Cardinals.N, ref fix); |
2722 | } | 2725 | } |
2723 | 2726 | ||
2724 | |||
2725 | // Makes sure avatar does not end up outside region | 2727 | // Makes sure avatar does not end up outside region |
2726 | if (neighbor <= 0) | 2728 | if (neighbor <= 0) |
2727 | { | 2729 | { |
@@ -2794,6 +2796,15 @@ namespace OpenSim.Region.Framework.Scenes | |||
2794 | } | 2796 | } |
2795 | } | 2797 | } |
2796 | 2798 | ||
2799 | /// <summary> | ||
2800 | /// Checks whether this region has a neighbour in the given direction. | ||
2801 | /// </summary> | ||
2802 | /// <param name="car"></param> | ||
2803 | /// <param name="fix"></param> | ||
2804 | /// <returns> | ||
2805 | /// An integer which represents a compass point. N == 1, going clockwise until we reach NW == 8. | ||
2806 | /// Returns a positive integer if there is a region in that direction, a negative integer if not. | ||
2807 | /// </returns> | ||
2797 | protected int HaveNeighbor(Cardinals car, ref int[] fix) | 2808 | protected int HaveNeighbor(Cardinals car, ref int[] fix) |
2798 | { | 2809 | { |
2799 | uint neighbourx = m_regionInfo.RegionLocX; | 2810 | uint neighbourx = m_regionInfo.RegionLocX; |