From 5b325f1f544ba0154035109d1b98e40f54313ddf Mon Sep 17 00:00:00 2001
From: Teravus Ovares (Dan Olivares)
Date: Thu, 13 Aug 2009 12:39:33 -0400
Subject: * minor: comments
---
OpenSim/Framework/LandData.cs | 126 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 125 insertions(+), 1 deletion(-)
(limited to 'OpenSim')
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
private int _dwell = 0;
private int _otherCleanTime = 0;
+ ///
+ /// Upper corner of the AABB for the parcel
+ ///
public Vector3 AABBMax {
get {
return _AABBMax;
@@ -91,7 +94,9 @@ namespace OpenSim.Framework
_AABBMax = value;
}
}
-
+ ///
+ /// Lower corner of the AABB for the parcel
+ ///
public Vector3 AABBMin {
get {
return _AABBMin;
@@ -101,6 +106,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Area in meters^2 the parcel contains
+ ///
public int Area {
get {
return _area;
@@ -110,6 +118,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// ID of auction (3rd Party Integration) when parcel is being auctioned
+ ///
public uint AuctionID {
get {
return _auctionID;
@@ -119,6 +130,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// UUID of authorized buyer of parcel. This is UUID.Zero if anyone can buy it.
+ ///
public UUID AuthBuyerID {
get {
return _authBuyerID;
@@ -128,6 +142,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Category of parcel. Used for classifying the parcel in classified listings
+ ///
public ParcelCategory Category {
get {
return _category;
@@ -137,6 +154,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Date that the current owner purchased or claimed the parcel
+ ///
public int ClaimDate {
get {
return _claimDate;
@@ -146,6 +166,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// The last price that the parcel was sold at
+ ///
public int ClaimPrice {
get {
return _claimPrice;
@@ -155,6 +178,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Global ID for the parcel. (3rd Party Integration)
+ ///
public UUID GlobalID {
get {
return _globalID;
@@ -164,6 +190,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Unique ID of the Group that owns
+ ///
public UUID GroupID {
get {
return _groupID;
@@ -173,6 +202,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of SceneObjectPart that are owned by a Group
+ ///
public int GroupPrims {
get {
return _groupPrims;
@@ -182,6 +214,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Returns true if the Land Parcel is owned by a group
+ ///
public bool IsGroupOwned {
get {
return _isGroupOwned;
@@ -191,6 +226,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// jp2 data for the image representative of the parcel in the parcel dialog
+ ///
public byte[] Bitmap {
get {
return _bitmap;
@@ -200,6 +238,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Parcel Description
+ ///
public string Description {
get {
return _description;
@@ -209,6 +250,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Parcel settings. Access flags, Fly, NoPush, Voice, Scripts allowed, etc. ParcelFlags
+ ///
public uint Flags {
get {
return _flags;
@@ -218,6 +262,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Determines if people are able to teleport where they please on the parcel or if they
+ /// get constrainted to a specific point on teleport within the parcel
+ ///
public byte LandingType {
get {
return _landingType;
@@ -227,6 +275,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Parcel Name
+ ///
public string Name {
get {
return _name;
@@ -236,6 +287,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Status of Parcel, Leased, Abandoned, For Sale
+ ///
public ParcelStatus Status {
get {
return _status;
@@ -245,6 +299,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Internal ID of the parcel. Sometimes the client will try to use this value
+ ///
public int LocalID {
get {
return _localID;
@@ -254,6 +311,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Determines if we scale the media based on the surface it's on
+ ///
public byte MediaAutoScale {
get {
return _mediaAutoScale;
@@ -263,6 +323,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Texture Guid to replace with the output of the media stream
+ ///
public UUID MediaID {
get {
return _mediaID;
@@ -272,6 +335,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// URL to the media file to display
+ ///
public string MediaURL {
get {
return _mediaURL;
@@ -281,6 +347,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// URL to the shoutcast music stream to play on the parcel
+ ///
public string MusicURL {
get {
return _musicURL;
@@ -290,6 +359,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of SceneObjectPart that are owned by users who do not own the parcel
+ /// and don't have the 'group. These are elegable for AutoReturn collection
+ ///
public int OtherPrims {
get {
return _otherPrims;
@@ -299,6 +372,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Owner Avatar or Group of the parcel. Naturally, all land masses must be
+ /// owned by someone
+ ///
public UUID OwnerID {
get {
return _ownerID;
@@ -308,6 +385,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of SceneObjectPart that are owned by the owner of the parcel
+ ///
public int OwnerPrims {
get {
return _ownerPrims;
@@ -317,6 +397,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// List of access data for the parcel. User data, some bitflags, and a time
+ ///
public List ParcelAccessList {
get {
return _parcelAccessList;
@@ -326,6 +409,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// How long in hours a Pass to the parcel is given
+ ///
public float PassHours {
get {
return _passHours;
@@ -335,6 +421,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Price to purchase a Pass to a restricted parcel
+ ///
public int PassPrice {
get {
return _passPrice;
@@ -344,6 +433,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// When the parcel is being sold, this is the price to purchase the parcel
+ ///
public int SalePrice {
get {
return _salePrice;
@@ -353,6 +445,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of SceneObjectPart that are currently selected by avatar
+ ///
public int SelectedPrims {
get {
return _selectedPrims;
@@ -362,6 +457,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of meters^2 in the Simulator
+ ///
public int SimwideArea {
get {
return _simwideArea;
@@ -371,6 +469,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of SceneObjectPart in the Simulator
+ ///
public int SimwidePrims {
get {
return _simwidePrims;
@@ -380,6 +481,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// ID of the snapshot used in the client parcel dialog of the parcel
+ ///
public UUID SnapshotID {
get {
return _snapshotID;
@@ -389,6 +493,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// When teleporting is restricted to a certain point, this is the location
+ /// that the user will be redirected to
+ ///
public Vector3 UserLocation {
get {
return _userLocation;
@@ -398,6 +506,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// When teleporting is restricted to a certain point, this is the rotation
+ /// that the user will be positioned
+ ///
public Vector3 UserLookAt {
get {
return _userLookAt;
@@ -407,6 +519,9 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Depreciated idea. Number of visitors ~= free money
+ ///
public int Dwell {
get {
return _dwell;
@@ -416,6 +531,10 @@ namespace OpenSim.Framework
}
}
+ ///
+ /// Number of minutes to return SceneObjectGroup that are owned by someone who doesn't own
+ /// the parcel and isn't set to the same 'group' as the parcel.
+ ///
public int OtherCleanTime {
get {
return _otherCleanTime;
@@ -425,11 +544,16 @@ namespace OpenSim.Framework
}
}
+
public LandData()
{
_globalID = UUID.Random();
}
+ ///
+ /// Make a new copy of the land data
+ ///
+ ///
public LandData Copy()
{
LandData landData = new LandData();
--
cgit v1.1