OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor: Add documentation to IGridService.GetRegionFlags()

connector_plugin
Justin Clark-Casey (justincc) 2012-10-09 01:40:40 +01:00
parent a0d047413b
commit ef3cc2e507
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
OpenSim/Framework/RegionFlags.cs
View File

@ -34,6 +34,7 @@ namespace OpenSim.Framework
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Don't confuse with OpenMetaverse.RegionFlags which are client facing flags (i.e. they go over the wire). /// Don't confuse with OpenMetaverse.RegionFlags which are client facing flags (i.e. they go over the wire).
/// Returned by IGridService.GetRegionFlags()
/// </remarks> /// </remarks>
[Flags] [Flags]
public enum RegionFlags : int public enum RegionFlags : int

13
OpenSim/Services/Interfaces/IGridService.cs
View File

@ -100,6 +100,19 @@ namespace OpenSim.Services.Interfaces
List<GridRegion> GetFallbackRegions(UUID scopeID, int x, int y); List<GridRegion> GetFallbackRegions(UUID scopeID, int x, int y);
List<GridRegion> GetHyperlinks(UUID scopeID); List<GridRegion> GetHyperlinks(UUID scopeID);
/// <summary>
/// Get internal OpenSimulator region flags.
/// </summary>
/// <remarks>
/// See OpenSimulator.Framework.RegionFlags. These are not returned in the GridRegion structure -
/// they currently need to be requested separately. Possibly this should change to avoid multiple service calls
/// in some situations.
/// </remarks>
/// <returns>
/// The region flags.
/// </returns>
/// <param name='scopeID'></param>
/// <param name='regionID'></param>
int GetRegionFlags(UUID scopeID, UUID regionID); int GetRegionFlags(UUID scopeID, UUID regionID);
} }