* minor: comments

arthursv
Teravus Ovares (Dan Olivares) 2009-08-13 12:39:33 -04:00
parent 0a85d1d767
commit 5b325f1f54
1 changed files with 125 additions and 1 deletions

View File

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