diff options
author | Justin Clark-Casey (justincc) | 2009-11-25 17:49:38 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2009-11-25 17:49:38 +0000 |
commit | 59caa68e08691d8fac221e2bd42c712d5bcf69aa (patch) | |
tree | 915bc994591cdde83cba738d4f5a55d018aa7c3f /OpenSim/Region/Framework/Interfaces/ILandChannel.cs | |
parent | Change chat config code so that enabled = false actually does disable the cha... (diff) | |
download | opensim-SC-59caa68e08691d8fac221e2bd42c712d5bcf69aa.zip opensim-SC-59caa68e08691d8fac221e2bd42c712d5bcf69aa.tar.gz opensim-SC-59caa68e08691d8fac221e2bd42c712d5bcf69aa.tar.bz2 opensim-SC-59caa68e08691d8fac221e2bd42c712d5bcf69aa.tar.xz |
minor: add doc to a few parcel methods
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/ILandChannel.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/ILandChannel.cs | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs index 74f404f..6fe6118 100644 --- a/OpenSim/Region/Framework/Interfaces/ILandChannel.cs +++ b/OpenSim/Region/Framework/Interfaces/ILandChannel.cs | |||
@@ -33,26 +33,41 @@ namespace OpenSim.Region.Framework.Interfaces | |||
33 | { | 33 | { |
34 | public interface ILandChannel | 34 | public interface ILandChannel |
35 | { | 35 | { |
36 | List<ILandObject> ParcelsNearPoint(Vector3 position); | 36 | /// <summary> |
37 | /// Get all parcels | ||
38 | /// </summary> | ||
39 | /// <returns></returns> | ||
37 | List<ILandObject> AllParcels(); | 40 | List<ILandObject> AllParcels(); |
38 | 41 | ||
39 | /// <summary> | 42 | /// <summary> |
40 | /// Get the land object at the specified point | 43 | /// Get the parcel at the specified point |
41 | /// </summary> | 44 | /// </summary> |
42 | /// <param name="x">Value between 0 - 256 on the x axis of the point</param> | 45 | /// <param name="x">Value between 0 - 256 on the x axis of the point</param> |
43 | /// <param name="y">Value between 0 - 256 on the y axis of the point</param> | 46 | /// <param name="y">Value between 0 - 256 on the y axis of the point</param> |
44 | /// <returns>Land object at the point supplied</returns> | 47 | /// <returns>Land object at the point supplied</returns> |
45 | ILandObject GetLandObject(int x, int y); | 48 | ILandObject GetLandObject(int x, int y); |
46 | 49 | ||
47 | ILandObject GetLandObject(int localID); | ||
48 | |||
49 | /// <summary> | 50 | /// <summary> |
50 | /// Get the land object at the specified point | 51 | /// Get the parcel at the specified point |
51 | /// </summary> | 52 | /// </summary> |
52 | /// <param name="x">Value between 0 - 256 on the x axis of the point</param> | 53 | /// <param name="x">Value between 0 - 256 on the x axis of the point</param> |
53 | /// <param name="y">Value between 0 - 256 on the y axis of the point</param> | 54 | /// <param name="y">Value between 0 - 256 on the y axis of the point</param> |
54 | /// <returns>Land object at the point supplied</returns> | 55 | /// <returns>Land object at the point supplied</returns> |
55 | ILandObject GetLandObject(float x, float y); | 56 | ILandObject GetLandObject(float x, float y); |
57 | |||
58 | /// <summary> | ||
59 | /// Get the parcels near the specified point | ||
60 | /// </summary> | ||
61 | /// <param name="position"></param> | ||
62 | /// <returns></returns> | ||
63 | List<ILandObject> ParcelsNearPoint(Vector3 position); | ||
64 | |||
65 | /// <summary> | ||
66 | /// Get the parcel given the land's local id. | ||
67 | /// </summary> | ||
68 | /// <param name="localID"></param> | ||
69 | /// <returns></returns> | ||
70 | ILandObject GetLandObject(int localID); | ||
56 | 71 | ||
57 | bool IsLandPrimCountTainted(); | 72 | bool IsLandPrimCountTainted(); |
58 | bool IsForcefulBansAllowed(); | 73 | bool IsForcefulBansAllowed(); |