aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework
diff options
context:
space:
mode:
authorTeravus Ovares (Dan Olivares)2009-08-13 12:39:33 -0400
committerTeravus Ovares (Dan Olivares)2009-08-13 12:39:33 -0400
commit5b325f1f544ba0154035109d1b98e40f54313ddf (patch)
tree7313748bdf86633790090cfdc840decbc2457f5a /OpenSim/Framework
parentminor:comments (diff)
downloadopensim-SC_OLD-5b325f1f544ba0154035109d1b98e40f54313ddf.zip
opensim-SC_OLD-5b325f1f544ba0154035109d1b98e40f54313ddf.tar.gz
opensim-SC_OLD-5b325f1f544ba0154035109d1b98e40f54313ddf.tar.bz2
opensim-SC_OLD-5b325f1f544ba0154035109d1b98e40f54313ddf.tar.xz
* minor: comments
Diffstat (limited to 'OpenSim/Framework')
-rw-r--r--OpenSim/Framework/LandData.cs126
1 files changed, 125 insertions, 1 deletions
diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs
index 94c0d3b..a24af04 100644
--- a/OpenSim/Framework/LandData.cs
+++ b/OpenSim/Framework/LandData.cs
@@ -83,6 +83,9 @@ namespace OpenSim.Framework
83 private int _dwell = 0; 83 private int _dwell = 0;
84 private int _otherCleanTime = 0; 84 private int _otherCleanTime = 0;
85 85
86 /// <summary>
87 /// Upper corner of the AABB for the parcel
88 /// </summary>
86 public Vector3 AABBMax { 89 public Vector3 AABBMax {
87 get { 90 get {
88 return _AABBMax; 91 return _AABBMax;
@@ -91,7 +94,9 @@ namespace OpenSim.Framework
91 _AABBMax = value; 94 _AABBMax = value;
92 } 95 }
93 } 96 }
94 97 /// <summary>
98 /// Lower corner of the AABB for the parcel
99 /// </summary>
95 public Vector3 AABBMin { 100 public Vector3 AABBMin {
96 get { 101 get {
97 return _AABBMin; 102 return _AABBMin;
@@ -101,6 +106,9 @@ namespace OpenSim.Framework
101 } 106 }
102 } 107 }
103 108
109 /// <summary>
110 /// Area in meters^2 the parcel contains
111 /// </summary>
104 public int Area { 112 public int Area {
105 get { 113 get {
106 return _area; 114 return _area;
@@ -110,6 +118,9 @@ namespace OpenSim.Framework
110 } 118 }
111 } 119 }
112 120
121 /// <summary>
122 /// ID of auction (3rd Party Integration) when parcel is being auctioned
123 /// </summary>
113 public uint AuctionID { 124 public uint AuctionID {
114 get { 125 get {
115 return _auctionID; 126 return _auctionID;
@@ -119,6 +130,9 @@ namespace OpenSim.Framework
119 } 130 }
120 } 131 }
121 132
133 /// <summary>
134 /// UUID of authorized buyer of parcel. This is UUID.Zero if anyone can buy it.
135 /// </summary>
122 public UUID AuthBuyerID { 136 public UUID AuthBuyerID {
123 get { 137 get {
124 return _authBuyerID; 138 return _authBuyerID;
@@ -128,6 +142,9 @@ namespace OpenSim.Framework
128 } 142 }
129 } 143 }
130 144
145 /// <summary>
146 /// Category of parcel. Used for classifying the parcel in classified listings
147 /// </summary>
131 public ParcelCategory Category { 148 public ParcelCategory Category {
132 get { 149 get {
133 return _category; 150 return _category;
@@ -137,6 +154,9 @@ namespace OpenSim.Framework
137 } 154 }
138 } 155 }
139 156
157 /// <summary>
158 /// Date that the current owner purchased or claimed the parcel
159 /// </summary>
140 public int ClaimDate { 160 public int ClaimDate {
141 get { 161 get {
142 return _claimDate; 162 return _claimDate;
@@ -146,6 +166,9 @@ namespace OpenSim.Framework
146 } 166 }
147 } 167 }
148 168
169 /// <summary>
170 /// The last price that the parcel was sold at
171 /// </summary>
149 public int ClaimPrice { 172 public int ClaimPrice {
150 get { 173 get {
151 return _claimPrice; 174 return _claimPrice;
@@ -155,6 +178,9 @@ namespace OpenSim.Framework
155 } 178 }
156 } 179 }
157 180
181 /// <summary>
182 /// Global ID for the parcel. (3rd Party Integration)
183 /// </summary>
158 public UUID GlobalID { 184 public UUID GlobalID {
159 get { 185 get {
160 return _globalID; 186 return _globalID;
@@ -164,6 +190,9 @@ namespace OpenSim.Framework
164 } 190 }
165 } 191 }
166 192
193 /// <summary>
194 /// Unique ID of the Group that owns
195 /// </summary>
167 public UUID GroupID { 196 public UUID GroupID {
168 get { 197 get {
169 return _groupID; 198 return _groupID;
@@ -173,6 +202,9 @@ namespace OpenSim.Framework
173 } 202 }
174 } 203 }
175 204
205 /// <summary>
206 /// Number of SceneObjectPart that are owned by a Group
207 /// </summary>
176 public int GroupPrims { 208 public int GroupPrims {
177 get { 209 get {
178 return _groupPrims; 210 return _groupPrims;
@@ -182,6 +214,9 @@ namespace OpenSim.Framework
182 } 214 }
183 } 215 }
184 216
217 /// <summary>
218 /// Returns true if the Land Parcel is owned by a group
219 /// </summary>
185 public bool IsGroupOwned { 220 public bool IsGroupOwned {
186 get { 221 get {
187 return _isGroupOwned; 222 return _isGroupOwned;
@@ -191,6 +226,9 @@ namespace OpenSim.Framework
191 } 226 }
192 } 227 }
193 228
229 /// <summary>
230 /// jp2 data for the image representative of the parcel in the parcel dialog
231 /// </summary>
194 public byte[] Bitmap { 232 public byte[] Bitmap {
195 get { 233 get {
196 return _bitmap; 234 return _bitmap;
@@ -200,6 +238,9 @@ namespace OpenSim.Framework
200 } 238 }
201 } 239 }
202 240
241 /// <summary>
242 /// Parcel Description
243 /// </summary>
203 public string Description { 244 public string Description {
204 get { 245 get {
205 return _description; 246 return _description;
@@ -209,6 +250,9 @@ namespace OpenSim.Framework
209 } 250 }
210 } 251 }
211 252
253 /// <summary>
254 /// Parcel settings. Access flags, Fly, NoPush, Voice, Scripts allowed, etc. ParcelFlags
255 /// </summary>
212 public uint Flags { 256 public uint Flags {
213 get { 257 get {
214 return _flags; 258 return _flags;
@@ -218,6 +262,10 @@ namespace OpenSim.Framework
218 } 262 }
219 } 263 }
220 264
265 /// <summary>
266 /// Determines if people are able to teleport where they please on the parcel or if they
267 /// get constrainted to a specific point on teleport within the parcel
268 /// </summary>
221 public byte LandingType { 269 public byte LandingType {
222 get { 270 get {
223 return _landingType; 271 return _landingType;
@@ -227,6 +275,9 @@ namespace OpenSim.Framework
227 } 275 }
228 } 276 }
229 277
278 /// <summary>
279 /// Parcel Name
280 /// </summary>
230 public string Name { 281 public string Name {
231 get { 282 get {
232 return _name; 283 return _name;
@@ -236,6 +287,9 @@ namespace OpenSim.Framework
236 } 287 }
237 } 288 }
238 289
290 /// <summary>
291 /// Status of Parcel, Leased, Abandoned, For Sale
292 /// </summary>
239 public ParcelStatus Status { 293 public ParcelStatus Status {
240 get { 294 get {
241 return _status; 295 return _status;
@@ -245,6 +299,9 @@ namespace OpenSim.Framework
245 } 299 }
246 } 300 }
247 301
302 /// <summary>
303 /// Internal ID of the parcel. Sometimes the client will try to use this value
304 /// </summary>
248 public int LocalID { 305 public int LocalID {
249 get { 306 get {
250 return _localID; 307 return _localID;
@@ -254,6 +311,9 @@ namespace OpenSim.Framework
254 } 311 }
255 } 312 }
256 313
314 /// <summary>
315 /// Determines if we scale the media based on the surface it's on
316 /// </summary>
257 public byte MediaAutoScale { 317 public byte MediaAutoScale {
258 get { 318 get {
259 return _mediaAutoScale; 319 return _mediaAutoScale;
@@ -263,6 +323,9 @@ namespace OpenSim.Framework
263 } 323 }
264 } 324 }
265 325
326 /// <summary>
327 /// Texture Guid to replace with the output of the media stream
328 /// </summary>
266 public UUID MediaID { 329 public UUID MediaID {
267 get { 330 get {
268 return _mediaID; 331 return _mediaID;
@@ -272,6 +335,9 @@ namespace OpenSim.Framework
272 } 335 }
273 } 336 }
274 337
338 /// <summary>
339 /// URL to the media file to display
340 /// </summary>
275 public string MediaURL { 341 public string MediaURL {
276 get { 342 get {
277 return _mediaURL; 343 return _mediaURL;
@@ -281,6 +347,9 @@ namespace OpenSim.Framework
281 } 347 }
282 } 348 }
283 349
350 /// <summary>
351 /// URL to the shoutcast music stream to play on the parcel
352 /// </summary>
284 public string MusicURL { 353 public string MusicURL {
285 get { 354 get {
286 return _musicURL; 355 return _musicURL;
@@ -290,6 +359,10 @@ namespace OpenSim.Framework
290 } 359 }
291 } 360 }
292 361
362 /// <summary>
363 /// Number of SceneObjectPart that are owned by users who do not own the parcel
364 /// and don't have the 'group. These are elegable for AutoReturn collection
365 /// </summary>
293 public int OtherPrims { 366 public int OtherPrims {
294 get { 367 get {
295 return _otherPrims; 368 return _otherPrims;
@@ -299,6 +372,10 @@ namespace OpenSim.Framework
299 } 372 }
300 } 373 }
301 374
375 /// <summary>
376 /// Owner Avatar or Group of the parcel. Naturally, all land masses must be
377 /// owned by someone
378 /// </summary>
302 public UUID OwnerID { 379 public UUID OwnerID {
303 get { 380 get {
304 return _ownerID; 381 return _ownerID;
@@ -308,6 +385,9 @@ namespace OpenSim.Framework
308 } 385 }
309 } 386 }
310 387
388 /// <summary>
389 /// Number of SceneObjectPart that are owned by the owner of the parcel
390 /// </summary>
311 public int OwnerPrims { 391 public int OwnerPrims {
312 get { 392 get {
313 return _ownerPrims; 393 return _ownerPrims;
@@ -317,6 +397,9 @@ namespace OpenSim.Framework
317 } 397 }
318 } 398 }
319 399
400 /// <summary>
401 /// List of access data for the parcel. User data, some bitflags, and a time
402 /// </summary>
320 public List<ParcelManager.ParcelAccessEntry> ParcelAccessList { 403 public List<ParcelManager.ParcelAccessEntry> ParcelAccessList {
321 get { 404 get {
322 return _parcelAccessList; 405 return _parcelAccessList;
@@ -326,6 +409,9 @@ namespace OpenSim.Framework
326 } 409 }
327 } 410 }
328 411
412 /// <summary>
413 /// How long in hours a Pass to the parcel is given
414 /// </summary>
329 public float PassHours { 415 public float PassHours {
330 get { 416 get {
331 return _passHours; 417 return _passHours;
@@ -335,6 +421,9 @@ namespace OpenSim.Framework
335 } 421 }
336 } 422 }
337 423
424 /// <summary>
425 /// Price to purchase a Pass to a restricted parcel
426 /// </summary>
338 public int PassPrice { 427 public int PassPrice {
339 get { 428 get {
340 return _passPrice; 429 return _passPrice;
@@ -344,6 +433,9 @@ namespace OpenSim.Framework
344 } 433 }
345 } 434 }
346 435
436 /// <summary>
437 /// When the parcel is being sold, this is the price to purchase the parcel
438 /// </summary>
347 public int SalePrice { 439 public int SalePrice {
348 get { 440 get {
349 return _salePrice; 441 return _salePrice;
@@ -353,6 +445,9 @@ namespace OpenSim.Framework
353 } 445 }
354 } 446 }
355 447
448 /// <summary>
449 /// Number of SceneObjectPart that are currently selected by avatar
450 /// </summary>
356 public int SelectedPrims { 451 public int SelectedPrims {
357 get { 452 get {
358 return _selectedPrims; 453 return _selectedPrims;
@@ -362,6 +457,9 @@ namespace OpenSim.Framework
362 } 457 }
363 } 458 }
364 459
460 /// <summary>
461 /// Number of meters^2 in the Simulator
462 /// </summary>
365 public int SimwideArea { 463 public int SimwideArea {
366 get { 464 get {
367 return _simwideArea; 465 return _simwideArea;
@@ -371,6 +469,9 @@ namespace OpenSim.Framework
371 } 469 }
372 } 470 }
373 471
472 /// <summary>
473 /// Number of SceneObjectPart in the Simulator
474 /// </summary>
374 public int SimwidePrims { 475 public int SimwidePrims {
375 get { 476 get {
376 return _simwidePrims; 477 return _simwidePrims;
@@ -380,6 +481,9 @@ namespace OpenSim.Framework
380 } 481 }
381 } 482 }
382 483
484 /// <summary>
485 /// ID of the snapshot used in the client parcel dialog of the parcel
486 /// </summary>
383 public UUID SnapshotID { 487 public UUID SnapshotID {
384 get { 488 get {
385 return _snapshotID; 489 return _snapshotID;
@@ -389,6 +493,10 @@ namespace OpenSim.Framework
389 } 493 }
390 } 494 }
391 495
496 /// <summary>
497 /// When teleporting is restricted to a certain point, this is the location
498 /// that the user will be redirected to
499 /// </summary>
392 public Vector3 UserLocation { 500 public Vector3 UserLocation {
393 get { 501 get {
394 return _userLocation; 502 return _userLocation;
@@ -398,6 +506,10 @@ namespace OpenSim.Framework
398 } 506 }
399 } 507 }
400 508
509 /// <summary>
510 /// When teleporting is restricted to a certain point, this is the rotation
511 /// that the user will be positioned
512 /// </summary>
401 public Vector3 UserLookAt { 513 public Vector3 UserLookAt {
402 get { 514 get {
403 return _userLookAt; 515 return _userLookAt;
@@ -407,6 +519,9 @@ namespace OpenSim.Framework
407 } 519 }
408 } 520 }
409 521
522 /// <summary>
523 /// Depreciated idea. Number of visitors ~= free money
524 /// </summary>
410 public int Dwell { 525 public int Dwell {
411 get { 526 get {
412 return _dwell; 527 return _dwell;
@@ -416,6 +531,10 @@ namespace OpenSim.Framework
416 } 531 }
417 } 532 }
418 533
534 /// <summary>
535 /// Number of minutes to return SceneObjectGroup that are owned by someone who doesn't own
536 /// the parcel and isn't set to the same 'group' as the parcel.
537 /// </summary>
419 public int OtherCleanTime { 538 public int OtherCleanTime {
420 get { 539 get {
421 return _otherCleanTime; 540 return _otherCleanTime;
@@ -425,11 +544,16 @@ namespace OpenSim.Framework
425 } 544 }
426 } 545 }
427 546
547
428 public LandData() 548 public LandData()
429 { 549 {
430 _globalID = UUID.Random(); 550 _globalID = UUID.Random();
431 } 551 }
432 552
553 /// <summary>
554 /// Make a new copy of the land data
555 /// </summary>
556 /// <returns></returns>
433 public LandData Copy() 557 public LandData Copy()
434 { 558 {
435 LandData landData = new LandData(); 559 LandData landData = new LandData();