diff --git a/LibreMetaverse.Rendering.Meshmerizer/MeshmerizerR.cs b/LibreMetaverse.Rendering.Meshmerizer/MeshmerizerR.cs index c641fb3a..12ae9505 100644 --- a/LibreMetaverse.Rendering.Meshmerizer/MeshmerizerR.cs +++ b/LibreMetaverse.Rendering.Meshmerizer/MeshmerizerR.cs @@ -322,7 +322,7 @@ namespace OpenMetaverse.Rendering /// /// Apply texture coordinate modifications from a - /// to a list of vertices + /// to a list of vertices /// /// Vertex list to modify texture coordinates for /// Center-point of the face diff --git a/LibreMetaverse/AgentManager.cs b/LibreMetaverse/AgentManager.cs index 1cdb19a3..e50f6b32 100644 --- a/LibreMetaverse/AgentManager.cs +++ b/LibreMetaverse/AgentManager.cs @@ -1273,18 +1273,18 @@ namespace OpenMetaverse /// "client", "agent", and "avatar" all represent the same thing public UUID AgentID { get; private set; } - /// Temporary assigned to this session, used for + /// Temporary assigned to this session, used for /// verifying our identity in packets public UUID SessionID { get; private set; } - /// Shared secret that is never sent over the wire + /// Shared secret that is never sent over the wire public UUID SecureSessionID { get; private set; } /// Your (client) avatar ID, local to the current region/sim public uint LocalID => localID; /// Where the avatar started at login. Can be "last", "home" - /// or a login + /// or a login public string StartLocation { get; private set; } = string.Empty; /// The access level of this agent, usually M, PG or A @@ -1295,13 +1295,13 @@ namespace OpenMetaverse public DateTime LastPositionUpdate { get; set; } - /// An representing the velocity of our agent + /// An representing the velocity of our agent public Vector3 Velocity => velocity; - /// An representing the acceleration of our agent + /// An representing the acceleration of our agent public Vector3 Acceleration => acceleration; - /// A which specifies the angular speed, and axis about which an Avatar is rotating. + /// A which specifies the angular speed, and axis about which an Avatar is rotating. public Vector3 AngularVelocity => angularVelocity; /// Region handle for 'home' region @@ -1345,7 +1345,7 @@ namespace OpenMetaverse /// zero if the avatar is not currently sitting public uint SittingOn => sittingOn; - /// Gets the of the agents active group. + /// Gets the of the agents active group. public UUID ActiveGroup { get; private set; } /// Gets the Agents powers in the currently active group @@ -1429,7 +1429,7 @@ namespace OpenMetaverse } } /// - /// A representing the agents current rotation + /// A representing the agents current rotation /// public Quaternion SimRotation { @@ -1498,7 +1498,7 @@ namespace OpenMetaverse /// /// Constructor, setup callbacks for packets related to our avatar /// - /// A reference to the Class + /// A reference to the Class public AgentManager(GridClient client) { Client = client; @@ -1762,7 +1762,7 @@ namespace OpenMetaverse /// /// Send an Instant Message to a group /// - /// of the group to send message to + /// of the group to send message to /// Text Message being sent. public void InstantMessageGroup(UUID groupID, string message) { @@ -1773,7 +1773,7 @@ namespace OpenMetaverse /// Send an Instant Message to a group the agent is a member of /// /// The name this IM will show up as being from - /// of the group to send message to + /// of the group to send message to /// Text message being sent public void InstantMessageGroup(string fromName, UUID groupID, string message) { @@ -1817,7 +1817,7 @@ namespace OpenMetaverse /// /// Send a request to join a group chat session /// - /// of Group to leave + /// of Group to leave public void RequestJoinGroupChat(UUID groupID) { ImprovedInstantMessagePacket im = new ImprovedInstantMessagePacket @@ -1851,7 +1851,7 @@ namespace OpenMetaverse /// Exit a group chat session. This will stop further Group chat messages /// from being sent until session is rejoined. /// - /// of Group chat session to leave + /// of Group chat session to leave public void RequestLeaveGroupChat(UUID groupID) { ImprovedInstantMessagePacket im = new ImprovedInstantMessagePacket @@ -1892,7 +1892,7 @@ namespace OpenMetaverse /// Channel initial request came on /// Index of button you're "clicking" /// Label of button you're "clicking" - /// of Object that sent the dialog request + /// of Object that sent the dialog request /// public void ReplyToScriptDialog(int channel, int buttonIndex, string buttonlabel, UUID objectID) { @@ -1920,7 +1920,7 @@ namespace OpenMetaverse /// /// Accept invite for to a chatterbox session /// - /// of session to accept invite to + /// of session to accept invite to public async Task ChatterBoxAcceptInvite(UUID session_id) { if (Client.Network.CurrentSim == null || Client.Network.CurrentSim.Caps == null) @@ -1949,7 +1949,7 @@ namespace OpenMetaverse /// /// Start a friends conference /// - /// List of UUIDs to start a conference with + /// List of UUIDs to start a conference with /// the temporary session ID returned in the callback> public void StartIMConference(List participants, UUID tmp_session_id) { @@ -1989,11 +1989,11 @@ namespace OpenMetaverse /// /// Start a particle stream between an agent and an object /// - /// Key of the source agent - /// Key of the target object + /// Key of the source agent + /// Key of the target object /// - /// The type from the enum - /// A unique for this effect + /// The type from the enum + /// A unique for this effect public void PointAtEffect(UUID sourceAvatar, UUID targetObject, Vector3d globalOffset, PointAtType type, UUID effectID) { @@ -2033,11 +2033,11 @@ namespace OpenMetaverse /// /// Start a particle stream between an agent and an object /// - /// Key of the source agent - /// Key of the target object - /// A representing the beams offset from the source - /// A which sets the avatars lookat animation - /// of the Effect + /// Key of the source agent + /// Key of the target object + /// A representing the beams offset from the source + /// A which sets the avatars lookat animation + /// of the Effect public void LookAtEffect(UUID sourceAvatar, UUID targetObject, Vector3d globalOffset, LookAtType type, UUID effectID) { @@ -2148,7 +2148,7 @@ namespace OpenMetaverse } /// - /// Create a particle swirl around a target position using a packet + /// Create a particle swirl around a target position using a packet /// /// global offset /// A object containing the combined red, green, blue and alpha @@ -2195,7 +2195,7 @@ namespace OpenMetaverse /// /// Sends a request to sit on the specified object /// - /// of the object to sit on + /// of the object to sit on /// Sit at offset public void RequestSit(UUID targetID, Vector3 offset) { @@ -2216,7 +2216,7 @@ namespace OpenMetaverse } /// - /// Follows a call to to actually sit on the object + /// Follows a call to to actually sit on the object /// public void Sit() { @@ -2464,7 +2464,7 @@ namespace OpenMetaverse /// /// Drag an object /// - /// of the object to drag + /// of the object to drag /// Drag target in region coordinates public void GrabUpdate(UUID objectID, Vector3 grabPosition) { @@ -2475,7 +2475,7 @@ namespace OpenMetaverse /// /// Overload: Drag an object /// - /// of the object to drag + /// of the object to drag /// Drag target in region coordinates /// /// The texture coordinates to grab @@ -2628,7 +2628,7 @@ namespace OpenMetaverse /// /// Give L$ to an object /// - /// object to give money to + /// object to give money to /// amount of L$ to give /// name of object public void GiveObjectMoney(UUID target, int amount, string objectName) @@ -2639,7 +2639,7 @@ namespace OpenMetaverse /// /// Give L$ to a group /// - /// group to give money to + /// group to give money to /// amount of L$ to give public void GiveGroupMoney(UUID target, int amount) { @@ -2649,7 +2649,7 @@ namespace OpenMetaverse /// /// Give L$ to a group /// - /// group to give money to + /// group to give money to /// amount of L$ to give /// description of transaction public void GiveGroupMoney(UUID target, int amount, string description) @@ -2718,7 +2718,7 @@ namespace OpenMetaverse /// /// Plays a gesture /// - /// Asset of the gesture + /// Asset of the gesture public void PlayGesture(UUID gestureID) { ThreadPool.QueueUserWorkItem(_ => @@ -2826,8 +2826,8 @@ namespace OpenMetaverse /// /// Mark gesture active /// - /// Inventory of the gesture - /// Asset of the gesture + /// Inventory of the gesture + /// Asset of the gesture public void ActivateGesture(UUID invID, UUID assetID) { ActivateGesturesPacket packet = new ActivateGesturesPacket @@ -2858,7 +2858,7 @@ namespace OpenMetaverse /// /// Mark gesture inactive /// - /// Inventory of the gesture + /// Inventory of the gesture public void DeactivateGesture(UUID invID) { DeactivateGesturesPacket p = new DeactivateGesturesPacket @@ -2891,7 +2891,7 @@ namespace OpenMetaverse /// /// Send an AgentAnimation packet that toggles a single animation on /// - /// The of the animation to start playing + /// The of the animation to start playing /// Whether to ensure delivery of this packet or not public void AnimationStart(UUID animation, bool reliable) { @@ -2903,7 +2903,7 @@ namespace OpenMetaverse /// /// Send an AgentAnimation packet that toggles a single animation off /// - /// The of a + /// The of a /// currently playing animation to stop playing /// Whether to ensure delivery of this packet or not public void AnimationStop(UUID animation, bool reliable) @@ -2916,7 +2916,7 @@ namespace OpenMetaverse /// /// Send an AgentAnimation packet that will toggle animations on or off /// - /// A list of animation s, and whether to + /// A list of animation s, and whether to /// turn that animation on or off /// Whether to ensure delivery of this packet or not public void Animate(Dictionary animations, bool reliable) @@ -2967,7 +2967,7 @@ namespace OpenMetaverse /// /// Teleport agent to a landmark /// - /// of the landmark to teleport agent to + /// of the landmark to teleport agent to /// true on success, false on failure public bool Teleport(UUID landmark) { @@ -3098,7 +3098,7 @@ namespace OpenMetaverse /// Teleport agent to another region /// /// handle of region to teleport agent to - /// position in destination sim to teleport to + /// position in destination sim to teleport to /// true on success, false on failure /// This call is blocking public bool Teleport(ulong regionHandle, Vector3 position) @@ -3110,8 +3110,8 @@ namespace OpenMetaverse /// Teleport agent to another region /// /// handle of region to teleport agent to - /// position in destination sim to teleport to - /// direction in destination sim agent will look at + /// position in destination sim to teleport to + /// direction in destination sim agent will look at /// true on success, false on failure /// This call is blocking public bool Teleport(ulong regionHandle, Vector3 position, Vector3 lookAt) @@ -3166,7 +3166,7 @@ namespace OpenMetaverse /// Request teleport to a another simulator /// /// handle of region to teleport agent to - /// position in destination sim to teleport to + /// position in destination sim to teleport to public void RequestTeleport(ulong regionHandle, Vector3 position) { RequestTeleport(regionHandle, position, new Vector3(0.0f, 1.0f, 0.0f)); @@ -3176,9 +3176,9 @@ namespace OpenMetaverse /// Request teleport to another region /// /// handle of region to teleport agent to - /// position in destination sim to teleport to - /// direction in destination sim agent will look at - /// Ignores the connection state of + /// position in destination sim to teleport to + /// direction in destination sim agent will look at + /// Ignores the connection state of public void RequestTeleport(ulong regionHandle, Vector3 position, Vector3 lookAt, bool ignoreCapsStatus = false) { if (ignoreCapsStatus || (Client.Network?.CurrentSim?.Caps != null && @@ -3215,7 +3215,7 @@ namespace OpenMetaverse /// /// Teleport agent to a landmark /// - /// of the landmark to teleport agent to + /// of the landmark to teleport agent to public void RequestTeleport(UUID landmark) { TeleportLandmarkRequestPacket p = new TeleportLandmarkRequestPacket @@ -3233,7 +3233,7 @@ namespace OpenMetaverse /// /// Send a teleport lure to another avatar with default "Join me in ..." invitation message /// - /// target avatars to lure + /// target avatars to lure public void SendTeleportLure(UUID targetID) { SendTeleportLure(targetID, $"Join me in {Client.Network.CurrentSim.Name}!"); @@ -3242,7 +3242,7 @@ namespace OpenMetaverse /// /// Send a teleport lure to another avatar with custom invitation message /// - /// target avatars to lure + /// target avatars to lure /// custom message to send with invitation public void SendTeleportLure(UUID targetID, string message) { @@ -3268,8 +3268,8 @@ namespace OpenMetaverse /// Respond to a teleport lure by either accepting it and initiating /// the teleport, or denying it /// - /// of the avatar sending the lure - /// IM session of the incoming lure request + /// of the avatar sending the lure + /// IM session of the incoming lure request /// true to accept the lure, false to decline it public void TeleportLureRespond(UUID requesterID, UUID sessionID, bool accept) { @@ -3298,8 +3298,8 @@ namespace OpenMetaverse /// /// Request a teleport lure from another agent /// - /// of the avatar lure is being requested from - /// IM session + /// of the avatar lure is being requested from + /// IM session /// message to send with request public void SendTeleportLureRequest(UUID targetID, UUID sessionID, string message) { @@ -3325,7 +3325,7 @@ namespace OpenMetaverse /// /// Update agent profile /// - /// struct containing updated + /// struct containing updated /// profile information public void UpdateProfile(Avatar.AvatarProperties profile) { @@ -3354,7 +3354,7 @@ namespace OpenMetaverse /// /// Update agent's profile interests /// - /// selection of interests from struct + /// selection of interests from struct public void UpdateInterests(Avatar.Interests interests) { AvatarInterestsUpdatePacket aiup = new AvatarInterestsUpdatePacket @@ -3537,7 +3537,7 @@ namespace OpenMetaverse /// /// Sets home location to agents current position /// - /// will fire an AlertMessage () with + /// will fire an AlertMessage () with /// success or failure message public void SetHome() { @@ -3563,7 +3563,7 @@ namespace OpenMetaverse /// Move an agent in to a simulator. This packet is the last packet /// needed to complete the transition in to a new simulator /// - /// Object + /// Object public void CompleteAgentMovement(Simulator simulator) { CompleteAgentMovementPacket move = new CompleteAgentMovementPacket @@ -3583,10 +3583,10 @@ namespace OpenMetaverse /// /// Reply to script permissions request /// - /// Object - /// of the itemID requesting permissions - /// of the taskID requesting permissions - /// list of permissions to allow + /// Object + /// of the itemID requesting permissions + /// of the taskID requesting permissions + /// list of permissions to allow public void ScriptQuestionReply(Simulator simulator, UUID itemID, UUID taskID, ScriptPermission permissions) { ScriptAnswerYesPacket yes = new ScriptAnswerYesPacket diff --git a/LibreMetaverse/AgentManagerMovement.cs b/LibreMetaverse/AgentManagerMovement.cs index 7da350ca..afcb19fa 100644 --- a/LibreMetaverse/AgentManagerMovement.cs +++ b/LibreMetaverse/AgentManagerMovement.cs @@ -152,7 +152,7 @@ namespace OpenMetaverse /// /// Agent movement and camera control /// - /// Agent movement is controlled by setting specific + /// Agent movement is controlled by setting specific /// After the control flags are set, An AgentUpdate is required to update the simulator of the specified flags /// This is most easily accomplished by setting one or more of the AgentMovement properties /// diff --git a/LibreMetaverse/AppearanceManager.cs b/LibreMetaverse/AppearanceManager.cs index cfc92c38..25e0e1f9 100644 --- a/LibreMetaverse/AppearanceManager.cs +++ b/LibreMetaverse/AppearanceManager.cs @@ -960,8 +960,8 @@ namespace OpenMetaverse } /// - /// Calls either or - /// depending on the value of + /// Calls either or + /// depending on the value of /// replaceItems /// /// List of wearable inventory items to add @@ -1070,8 +1070,8 @@ namespace OpenMetaverse /// /// Attach an item to our agent at a specific attach point /// - /// A to attach - /// the on the avatar + /// A to attach + /// the on the avatar /// If true replace existing attachment on this attachment point, otherwise add to it (multi-attachments) /// to attach the item to public void Attach(InventoryItem item, AttachmentPoint attachPoint, bool replace = true) @@ -1083,13 +1083,13 @@ namespace OpenMetaverse /// /// Attach an item to our agent specifying attachment details /// - /// The of the item to attach - /// The attachments owner + /// The of the item to attach + /// The attachments owner /// The name of the attachment /// The description of the attachment - /// The to apply when attached - /// The of the attachment - /// The on the agent + /// The to apply when attached + /// The of the attachment + /// The on the agent /// If true replace existing attachment on this attachment point, otherwise add to it (multi-attachments) /// to attach the item to public void Attach(UUID itemID, UUID ownerID, string name, string description, @@ -1122,9 +1122,9 @@ namespace OpenMetaverse } /// - /// Detach an item from our agent using an object + /// Detach an item from our agent using an object /// - /// An object + /// An object public void Detach(InventoryItem item) { Detach(item.UUID); diff --git a/LibreMetaverse/AssetManager.cs b/LibreMetaverse/AssetManager.cs index 3aa32b13..5ad01dae 100644 --- a/LibreMetaverse/AssetManager.cs +++ b/LibreMetaverse/AssetManager.cs @@ -746,7 +746,7 @@ namespace OpenMetaverse /// UUID of the file to request, if filename is /// left empty /// Asset type of , or - /// if filename is not empty + /// if filename is not empty /// Sets the FilePath in the request to Cache /// (4) if true, otherwise Unknown (0) is used /// @@ -946,10 +946,10 @@ namespace OpenMetaverse /// /// Request an asset be uploaded to the simulator /// - /// The Object containing the asset data + /// The Object containing the asset data /// If True, the asset once uploaded will be stored on the simulator /// in which the client was connected in addition to being stored on the asset server - /// The of the transfer, can be used to correlate the upload with + /// The of the transfer, can be used to correlate the upload with /// events being fired public UUID RequestUpload(Asset asset, bool storeLocal) { @@ -965,11 +965,11 @@ namespace OpenMetaverse /// /// Request an asset be uploaded to the simulator /// - /// The of the asset being uploaded + /// The of the asset being uploaded /// A byte array containing the encoded asset data /// If True, the asset once uploaded will be stored on the simulator /// in which the client was connected in addition to being stored on the asset server - /// The of the transfer, can be used to correlate the upload with + /// The of the transfer, can be used to correlate the upload with /// events being fired public UUID RequestUpload(AssetType type, byte[] data, bool storeLocal) { @@ -985,7 +985,7 @@ namespace OpenMetaverse /// A byte array containing the encoded asset data /// If True, the asset once uploaded will be stored on the simulator /// in which the client was connected in addition to being stored on the asset server - /// The of the transfer, can be used to correlate the upload with + /// The of the transfer, can be used to correlate the upload with /// events being fired public UUID RequestUpload(out UUID assetID, AssetType type, byte[] data, bool storeLocal) { diff --git a/LibreMetaverse/Assets/AssetTypes/AssetBodypart.cs b/LibreMetaverse/Assets/AssetTypes/AssetBodypart.cs index 3686b8bd..76d632a5 100644 --- a/LibreMetaverse/Assets/AssetTypes/AssetBodypart.cs +++ b/LibreMetaverse/Assets/AssetTypes/AssetBodypart.cs @@ -27,7 +27,7 @@ namespace OpenMetaverse.Assets { /// - /// Represents an that represents an avatars body ie: Hair, Etc. + /// Represents an that represents an avatars body ie: Hair, Etc. /// public class AssetBodypart : AssetWearable { diff --git a/LibreMetaverse/Assets/AssetTypes/AssetClothing.cs b/LibreMetaverse/Assets/AssetTypes/AssetClothing.cs index c096475e..9aa6c509 100644 --- a/LibreMetaverse/Assets/AssetTypes/AssetClothing.cs +++ b/LibreMetaverse/Assets/AssetTypes/AssetClothing.cs @@ -27,7 +27,7 @@ namespace OpenMetaverse.Assets { /// - /// Represents an that can be worn on an avatar + /// Represents an that can be worn on an avatar /// such as a Shirt, Pants, etc. /// public class AssetClothing : AssetWearable diff --git a/LibreMetaverse/Assets/AssetTypes/AssetTexture.cs b/LibreMetaverse/Assets/AssetTypes/AssetTexture.cs index 6c7e03dd..23fd8e6d 100644 --- a/LibreMetaverse/Assets/AssetTypes/AssetTexture.cs +++ b/LibreMetaverse/Assets/AssetTypes/AssetTexture.cs @@ -38,7 +38,7 @@ namespace OpenMetaverse.Assets /// Override the base classes AssetType public override AssetType AssetType => AssetType.Texture; - /// A object containing image data + /// A object containing image data public ManagedImage Image; /// @@ -57,7 +57,7 @@ namespace OpenMetaverse.Assets /// /// Initializes a new instance of an AssetTexture object /// - /// A object containing texture data + /// A object containing texture data public AssetTexture(ManagedImage image) { Image = image; @@ -73,8 +73,8 @@ namespace OpenMetaverse.Assets } /// - /// Populates the byte array with a JPEG2000 - /// encoded image created from the data in + /// Populates the byte array with a JPEG2000 + /// encoded image created from the data in /// public sealed override void Encode() { @@ -83,7 +83,7 @@ namespace OpenMetaverse.Assets /// /// Decodes the JPEG2000 data in > to the - /// object + /// object /// /// True if the decoding was successful, otherwise false public sealed override bool Decode() diff --git a/LibreMetaverse/Assets/AssetTypes/AssetWearable.cs b/LibreMetaverse/Assets/AssetTypes/AssetWearable.cs index ca422817..539c40b8 100644 --- a/LibreMetaverse/Assets/AssetTypes/AssetWearable.cs +++ b/LibreMetaverse/Assets/AssetTypes/AssetWearable.cs @@ -45,21 +45,21 @@ namespace OpenMetaverse.Assets public SaleType ForSale; /// An Integer representing the purchase price of the asset public int SalePrice; - /// The of the assets creator + /// The of the assets creator public UUID Creator; - /// The of the assets current owner + /// The of the assets current owner public UUID Owner; - /// The of the assets prior owner + /// The of the assets prior owner public UUID LastOwner; - /// The of the Group this asset is set to + /// The of the Group this asset is set to public UUID Group; - /// True if the asset is owned by a + /// True if the asset is owned by a public bool GroupOwned; /// The Permissions mask of the asset public Permissions Permissions; /// A Dictionary containing Key/Value pairs of the objects parameters public Dictionary Params = new Dictionary(); - /// A Dictionary containing Key/Value pairs where the Key is the textures Index and the Value is the Textures + /// A Dictionary containing Key/Value pairs where the Key is the textures Index and the Value is the Textures public Dictionary Textures = new Dictionary(); /// Initializes a new instance of an AssetWearable object diff --git a/LibreMetaverse/Capabilities/CapsClient.cs b/LibreMetaverse/Capabilities/CapsClient.cs index 5b2c1a6a..df42450c 100644 --- a/LibreMetaverse/Capabilities/CapsClient.cs +++ b/LibreMetaverse/Capabilities/CapsClient.cs @@ -58,7 +58,7 @@ namespace OpenMetaverse.Http /// /// CapsClient Ctor /// - /// for simulator capability + /// for simulator capability public CapsClient(Uri capability) : this(capability, null, null) { @@ -67,7 +67,7 @@ namespace OpenMetaverse.Http /// /// CapsClient Ctor with name /// - /// for simulator capability + /// for simulator capability /// Simulator capability name public CapsClient(Uri capability, string cap_name) : this(capability, cap_name, null) @@ -77,9 +77,9 @@ namespace OpenMetaverse.Http /// /// CapsClient Ctor with name and certificate /// - /// for simulator capability + /// for simulator capability /// Simulator capability name - /// client certificate + /// client certificate public CapsClient(Uri capability, string cap_name, X509Certificate2 clientCert) { _Address = capability; @@ -302,7 +302,7 @@ namespace OpenMetaverse.Http /// /// Serializes OSD data for http request /// - /// formatted data for input + /// formatted data for input /// Format to serialize data to /// Output serialized data as byte array /// content-type string of serialized data diff --git a/LibreMetaverse/DirectoryManager.cs b/LibreMetaverse/DirectoryManager.cs index c83881fb..e71b4a5b 100644 --- a/LibreMetaverse/DirectoryManager.cs +++ b/LibreMetaverse/DirectoryManager.cs @@ -857,7 +857,7 @@ namespace OpenMetaverse /// /// Starts a search for land sales using the directory /// - /// The event is raised when a response is received from the simulator + /// The event is raised when a response is received from the simulator /// /// What type of land to search for. Auction, /// estate, mainland, "first land", etc @@ -909,7 +909,7 @@ namespace OpenMetaverse /// Each request is limited to 100 parcels /// being returned. To get the first 100 parcels of a request use 0, /// from 100-199 use 100, 200-299 use 200, etc. - /// The event will be raised with the response from the simulator + /// The event will be raised with the response from the simulator /// /// There is no way to determine how many results will be returned, or how many times the callback will be /// fired other than you won't get more than 100 total parcels from diff --git a/LibreMetaverse/FriendsManager.cs b/LibreMetaverse/FriendsManager.cs index 58e2fd92..3044e451 100644 --- a/LibreMetaverse/FriendsManager.cs +++ b/LibreMetaverse/FriendsManager.cs @@ -418,7 +418,7 @@ namespace OpenMetaverse /// /// A dictionary of key/value pairs containing known friends of this avatar. /// - /// The Key is the of the friend, the value is a + /// The Key is the of the friend, the value is a /// object that contains detailed information including permissions you have and have given to the friend /// public LockingDictionary FriendList = new LockingDictionary(); @@ -426,8 +426,8 @@ namespace OpenMetaverse /// /// A Dictionary of key/value pairs containing current pending frienship offers. /// - /// The key is the of the avatar making the request, - /// the value is the of the request which is used to accept + /// The key is the of the avatar making the request, + /// the value is the of the request which is used to accept /// or decline the friendship offer /// public LockingDictionary FriendRequests = new LockingDictionary(); @@ -499,8 +499,8 @@ namespace OpenMetaverse /// /// Accept friendship request. Only to be used if request was sent via Offline Msg cap - /// This can be determined by the presence of a - /// value in + /// This can be determined by the presence of a + /// value in /// /// agentID of avatar to form friendship with public void AcceptFriendshipCapability(UUID fromAgentID) @@ -550,7 +550,7 @@ namespace OpenMetaverse /// /// Decline a friendship request /// - /// of friend + /// of friend /// imSessionID of the friendship request message public void DeclineFriendship(UUID fromAgentID, UUID imSessionID) { @@ -576,10 +576,10 @@ namespace OpenMetaverse /// /// Decline friendship request. Only to be used if request was sent via Offline Msg cap - /// This can be determined by the presence of a - /// value in + /// This can be determined by the presence of a + /// value in /// - /// of friend + /// of friend public void DeclineFriendshipCap(UUID fromAgentID) { Uri declineFriendshipCap = Client.Network.CurrentSim.Caps.CapabilityURI("DeclineFriendship"); @@ -696,7 +696,7 @@ namespace OpenMetaverse /// /// Change the rights of a friend avatar. /// - /// the of the friend + /// the of the friend /// the new rights to give the friend /// This method will implicitly set the rights to those passed in the rights parameter. public void GrantRights(UUID friendID, FriendRights rights) @@ -723,7 +723,7 @@ namespace OpenMetaverse /// Use to map a friends location on the grid. /// /// Friends UUID to find - /// + /// public void MapFriend(UUID friendID) { FindAgentPacket stalk = new FindAgentPacket @@ -1028,13 +1028,13 @@ namespace OpenMetaverse } /// - /// Populate FriendList with data from the login reply + /// Populate FriendList with data from the login reply /// /// true if login was successful /// true if login request is requiring a redirect /// A string containing the response to the login request /// A string containing the reason for the request - /// A object containing the decoded + /// A object containing the decoded /// reply from the login server private void Network_OnLoginResponse(bool loginSuccess, bool redirect, string message, string reason, LoginResponseData replyData) diff --git a/LibreMetaverse/GridManager.cs b/LibreMetaverse/GridManager.cs index 8600a8eb..c91197cf 100644 --- a/LibreMetaverse/GridManager.cs +++ b/LibreMetaverse/GridManager.cs @@ -402,7 +402,7 @@ namespace OpenMetaverse /// /// Request a map layer from simulator capability /// - /// Requested + /// Requested public void RequestMapLayer(GridLayerType layer) { Uri cap = Client.Network.CurrentSim.Caps.CapabilityURI("MapLayer"); @@ -418,7 +418,7 @@ namespace OpenMetaverse /// Request a map layer through the simulator /// /// The name of the region - /// Requested + /// Requested public void RequestMapRegion(string regionName, GridLayerType layer) { MapNameRequestPacket request = new MapNameRequestPacket @@ -507,11 +507,11 @@ namespace OpenMetaverse } /// - /// Request for a given region + /// Request for a given region /// /// Requested region handle - /// being requested - /// being requested + /// being requested + /// being requested public void RequestMapItems(ulong regionHandle, GridItemType item, GridLayerType layer) { MapItemRequestPacket request = new MapItemRequestPacket @@ -576,15 +576,15 @@ namespace OpenMetaverse } /// - /// Retrieves information using the region name + /// Retrieves information using the region name /// /// This function will block until it can find the region or gives up - /// Region Handle of requested - /// for the - /// being requested - /// Output for the fetched , + /// Region Handle of requested + /// for the + /// being requested + /// Output for the fetched , /// or empty struct if failure - /// True if the was fetched, otherwise false + /// True if the was fetched, otherwise false public bool GetGridRegion(ulong handle, GridLayerType layer, out GridRegion region) { // Check if cached @@ -632,15 +632,15 @@ namespace OpenMetaverse } /// - /// Retrieves information using the region name + /// Retrieves information using the region name /// /// This function will block until it can find the region or gives up - /// Name of requested - /// for the - /// being requested - /// Output for the fetched , + /// Name of requested + /// for the + /// being requested + /// Output for the fetched , /// or empty struct if failure - /// True if the was fetched, otherwise false + /// True if the was fetched, otherwise false public bool GetGridRegion(string name, GridLayerType layer, out GridRegion region) { if (string.IsNullOrEmpty(name)) diff --git a/LibreMetaverse/GroupManager.cs b/LibreMetaverse/GroupManager.cs index c10cbf40..74649d1e 100644 --- a/LibreMetaverse/GroupManager.cs +++ b/LibreMetaverse/GroupManager.cs @@ -796,7 +796,7 @@ namespace OpenMetaverse private readonly object m_GroupNoticesListReplyLock = new object(); /// Raised when the simulator sends us group notices - /// + /// public event EventHandler GroupNoticesListReply { add { lock (m_GroupNoticesListReplyLock) { m_GroupNoticesListReply += value; } } @@ -855,7 +855,7 @@ namespace OpenMetaverse #endregion Delegates - /// A reference to the current instance + /// A reference to the current instance private GridClient Client; /// Currently-active group members requests private List GroupMembersRequests; @@ -875,7 +875,7 @@ namespace OpenMetaverse /// /// Construct a new instance of the GroupManager class /// - /// A reference to the current instance + /// A reference to the current instance public GroupManager(GridClient client) { Client = client; diff --git a/LibreMetaverse/Imaging/Targa.cs b/LibreMetaverse/Imaging/Targa.cs index f91dbc95..6921467b 100644 --- a/LibreMetaverse/Imaging/Targa.cs +++ b/LibreMetaverse/Imaging/Targa.cs @@ -34,7 +34,7 @@ namespace OpenMetaverse.Imaging { public static class Targa { - /// Decode Truvision TGA file to + /// Decode Truvision TGA file to public static SKBitmap Decode(string fileName) { using (var image = Pfimage.FromFile(fileName)) @@ -43,7 +43,7 @@ namespace OpenMetaverse.Imaging } } - /// Decode Truvision TGA stream to + /// Decode Truvision TGA stream to public static SKBitmap Decode(Stream stream) { using (var image = Pfimage.FromStream(stream)) diff --git a/LibreMetaverse/Interfaces/IRendering.cs b/LibreMetaverse/Interfaces/IRendering.cs index 073f01a8..279558c2 100644 --- a/LibreMetaverse/Interfaces/IRendering.cs +++ b/LibreMetaverse/Interfaces/IRendering.cs @@ -90,7 +90,7 @@ namespace OpenMetaverse.Rendering /// /// Apply texture coordinate modifications from a - /// to a list of vertices + /// to a list of vertices /// /// Vertex list to modify texture coordinates for /// Center-point of the face diff --git a/LibreMetaverse/InventoryManager.cs b/LibreMetaverse/InventoryManager.cs index 551b0724..f58f95fb 100644 --- a/LibreMetaverse/InventoryManager.cs +++ b/LibreMetaverse/InventoryManager.cs @@ -494,11 +494,11 @@ namespace OpenMetaverse /// /// Fetch an inventory item from the dataserver /// - /// The items - /// The item Owners - /// time to wait for results represented by - /// An object on success, or null if no item was found - /// Items will also be sent to the event + /// The items + /// The item Owners + /// time to wait for results represented by + /// An object on success, or null if no item was found + /// Items will also be sent to the event public InventoryItem FetchItem(UUID itemID, UUID ownerID, TimeSpan timeout) { var fetchEvent = new AutoResetEvent(false); @@ -525,9 +525,9 @@ namespace OpenMetaverse /// /// Request A single inventory item /// - /// The items - /// The item Owners - /// + /// The items + /// The item Owners + /// public void RequestFetchInventory(UUID itemID, UUID ownerID) { RequestFetchInventory(new Dictionary(1) { { itemID, ownerID } }); @@ -537,7 +537,7 @@ namespace OpenMetaverse /// Request inventory items /// /// Inventory items to request with owner - /// + /// public void RequestFetchInventory(Dictionary items) { if (Client.Network.CurrentSim.Caps?.CapabilityURI("FetchInventory2") != null) @@ -572,7 +572,7 @@ namespace OpenMetaverse /// Request inventory items via Capabilities /// /// Inventory items to request with owners - /// + /// private void RequestFetchInventoryHttp(Dictionary items) { _ = RequestFetchInventoryHttpAsync(items, CancellationToken.None); @@ -581,8 +581,8 @@ namespace OpenMetaverse /// /// Request inventory items via HTTP capability /// - /// The items - /// The item Owners + /// The items + /// The item Owners /// Cancellation token for operation /// Action private async Task RequestFetchInventoryHttpAsync(UUID itemID, UUID ownerID, @@ -657,15 +657,15 @@ namespace OpenMetaverse /// /// Retrieve contents of a folder /// - /// The of the folder to search - /// The of the folders owner + /// The of the folder to search + /// The of the folders owner /// retrieve folders /// retrieve items /// sort order to return results in /// time given to wait for results /// Resolve link items to the actual item /// A list of inventory items matching search criteria within folder - /// + /// /// InventoryFolder.DescendentCount will only be accurate if both folders and items are /// requested public List FolderContents(UUID folder, UUID owner, bool fetchFolders, bool fetchItems, @@ -721,12 +721,12 @@ namespace OpenMetaverse /// Request the contents of an inventory folder using HTTP capabilities /// /// The folder to search - /// The folder owners - /// true to return s contained in folder - /// true to return s contained in folder + /// The folder owners + /// true to return s contained in folder + /// true to return s contained in folder /// the sort order to return items in /// CancellationToken for operation - /// + /// public async Task RequestFolderContents(UUID folderID, UUID ownerID, bool fetchFolders, bool fetchItems, InventorySortOrder order, CancellationToken cancellationToken) { @@ -758,11 +758,11 @@ namespace OpenMetaverse /// /// of folders to search /// HTTP capability to POST - /// true to return s contained in folder - /// true to return s contained in folder + /// true to return s contained in folder + /// true to return s contained in folder /// the sort order to return items in /// CancellationToken for operation - /// + /// public async Task RequestFolderContents(List batch, Uri capabilityUri, bool fetchFolders, bool fetchItems, InventorySortOrder order, CancellationToken cancellationToken) { @@ -959,10 +959,10 @@ namespace OpenMetaverse /// Find an object in inventory using a specific path to search /// /// The folder to begin the search in - /// The object owners + /// The object owners /// A string path to search /// time to wait for reply - /// Found items or if + /// Found items or if /// timeout occurs or item is not found public UUID FindObjectByPath(UUID baseFolder, UUID inventoryOwner, string path, TimeSpan timeout) { @@ -992,9 +992,9 @@ namespace OpenMetaverse /// Find inventory items by path /// /// The folder to begin the search in - /// The object owners + /// The object owners /// A string path to search, folders/objects separated by a '/' - /// Results are sent to the event + /// Results are sent to the event public async Task RequestFindObjectByPath(UUID baseFolder, UUID inventoryOwner, string path) { if (string.IsNullOrEmpty(path)) @@ -1049,8 +1049,8 @@ namespace OpenMetaverse /// /// Move an inventory item or folder to a new location /// - /// The item or folder to move - /// The to move item or folder to + /// The item or folder to move + /// The to move item or folder to public void Move(InventoryBase item, InventoryFolder newParent) { if (item is InventoryFolder) @@ -1062,8 +1062,8 @@ namespace OpenMetaverse /// /// Move an inventory item or folder to a new location and change its name /// - /// The item or folder to move - /// The to move item or folder to + /// The item or folder to move + /// The to move item or folder to /// The name to change the item or folder to [Obsolete("Method broken with AIS3. Use Move(item, parent) instead.")] public void Move(InventoryBase item, InventoryFolder newParent, string newName) @@ -1077,8 +1077,8 @@ namespace OpenMetaverse /// /// Move and rename a folder /// - /// The source folders - /// The destination folders + /// The source folders + /// The destination folders /// The name to change the folder to [Obsolete("Method broken with AIS3. Use MoveFolder(folder, parent) and UpdateFolderProperties(folder, parent, name, type) instead")] public void MoveFolder(UUID folderID, UUID newparentID, string newName) @@ -1089,8 +1089,8 @@ namespace OpenMetaverse /// /// Update folder properties /// - /// of the folder to update - /// Sets folder's parent to + /// of the folder to update + /// Sets folder's parent to /// Folder name /// Folder type public void UpdateFolderProperties(UUID folderID, UUID parentID, string name, FolderType type) @@ -1155,8 +1155,8 @@ namespace OpenMetaverse /// /// Move a folder /// - /// The source folders - /// The destination folders + /// The source folders + /// The destination folders public void MoveFolder(UUID folderID, UUID newParentID) { lock (Store) @@ -1193,8 +1193,8 @@ namespace OpenMetaverse /// to a new parents, the value of that folder's key. /// /// A Dictionary containing the - /// of the source as the key, and the - /// of the destination as the value + /// of the source as the key, and the + /// of the destination as the value public void MoveFolders(Dictionary foldersNewParents) { // FIXME: Use two List to stay consistent @@ -1241,8 +1241,8 @@ namespace OpenMetaverse /// /// Move an inventory item to a new folder /// - /// The of the source item to move - /// The of the destination folder + /// The of the source item to move + /// The of the destination folder public void MoveItem(UUID itemID, UUID folderID) { MoveItem(itemID, folderID, string.Empty); @@ -1251,8 +1251,8 @@ namespace OpenMetaverse /// /// Move and rename an inventory item /// - /// The of the source item to move - /// The of the destination folder + /// The of the source item to move + /// The of the destination folder /// The name to change the folder to public void MoveItem(UUID itemID, UUID folderID, string newName) { @@ -1294,8 +1294,8 @@ namespace OpenMetaverse /// Move multiple inventory items to new locations /// /// A Dictionary containing the - /// of the source item as the key, and the - /// of the destination folder as the value + /// of the source item as the key, and the + /// of the destination folder as the value public void MoveItems(Dictionary itemsNewParents) { lock (_Store) @@ -1359,7 +1359,7 @@ namespace OpenMetaverse /// /// Remove descendants of a folder /// - /// The of the folder + /// The of the folder public void RemoveDescendants(UUID folder) { if (Client.AisClient.IsAvailable) @@ -1385,7 +1385,7 @@ namespace OpenMetaverse /// /// Remove a single item from inventory /// - /// The of the inventory item to remove + /// The of the inventory item to remove public void RemoveItem(UUID item) { if (Client.AisClient.IsAvailable) @@ -1404,7 +1404,7 @@ namespace OpenMetaverse /// /// Remove a folder from inventory /// - /// The of the folder to remove + /// The of the folder to remove public void RemoveFolder(UUID folder) { if (Client.AisClient.IsAvailable) @@ -1424,8 +1424,8 @@ namespace OpenMetaverse /// Remove multiple items or folders from inventory. Note that this uses the LLUDP method /// which Second Life has deprecated and removed. /// - /// A List containing the s of items to remove - /// A List containing the s of the folders to remove + /// A List containing the s of items to remove + /// A List containing the s of the folders to remove [Obsolete] public void Remove(List items, List folders) { @@ -2422,9 +2422,9 @@ namespace OpenMetaverse /// DeRez an object from the simulator and return to inventory /// /// The simulator Local ID of the object - /// The type of destination from the enum - /// The destination inventory folders -or- - /// if DeRezzing object to a tasks Inventory, the Tasks + /// The type of destination from the enum + /// The destination inventory folders -or- + /// if DeRezzing object to a tasks Inventory, the Tasks /// The transaction ID for this request which /// can be used to correlate this request with other packets /// If objectLocalID is a child primitive in a linkset, the entire linkset will be derezzed @@ -2506,10 +2506,10 @@ namespace OpenMetaverse /// /// Give an inventory item to another avatar /// - /// The of the item to give + /// The of the item to give /// The name of the item - /// The type of the item from the enum - /// The of the recipient + /// The type of the item from the enum + /// The of the recipient /// true to generate a beameffect during transfer public void GiveItem(UUID itemID, string itemName, AssetType assetType, UUID recipient, bool doEffect) @@ -2580,9 +2580,9 @@ namespace OpenMetaverse /// /// Give an inventory Folder with contents to another avatar /// - /// The of the Folder to give + /// The of the Folder to give /// The name of the folder - /// The of the recipient + /// The of the recipient /// true to generate a beameffect during transfer public void GiveFolder(UUID folderID, string folderName, UUID recipient, bool doEffect) { @@ -2718,7 +2718,7 @@ namespace OpenMetaverse /// /// Retrieve a listing of the items contained in a task (Primitive) /// - /// The tasks + /// The tasks /// The tasks simulator local ID /// time to wait for reply from simulator /// A list containing the inventory items inside the task or null @@ -2800,7 +2800,7 @@ namespace OpenMetaverse /// current simulator /// /// The LocalID of the object - /// + /// public void RequestTaskInventory(uint objectLocalID) { RequestTaskInventory(objectLocalID, Client.Network.CurrentSim); @@ -2811,7 +2811,7 @@ namespace OpenMetaverse /// /// The simulator Local ID of the object /// A reference to the simulator object that contains the object - /// + /// public void RequestTaskInventory(uint objectLocalID, Simulator simulator) { var request = new RequestTaskInventoryPacket @@ -2863,7 +2863,7 @@ namespace OpenMetaverse /// Simulator Object /// You can confirm the removal by comparing the tasks inventory serial before and after the /// request with the request combined with - /// the event + /// the event public void RemoveTaskInventory(uint objectLocalID, UUID taskItemID, Simulator simulator) { var remove = new RemoveTaskInventoryPacket @@ -2887,7 +2887,7 @@ namespace OpenMetaverse /// Copy an InventoryScript item from the Agents Inventory into a primitives task inventory /// /// An unsigned integer representing a primitive being simulated - /// An which represents a script object from the agents inventory + /// An which represents a script object from the agents inventory /// true to set the scripts running state to enabled /// A Unique Transaction ID /// @@ -2959,7 +2959,7 @@ namespace OpenMetaverse /// The ID of the script /// The event can be used to obtain the results of the /// request - /// + /// public void RequestGetScriptRunning(UUID objectID, UUID scriptID) { var request = new GetScriptRunningPacket @@ -3099,11 +3099,11 @@ namespace OpenMetaverse } /// - /// Wrapper for creating a new object + /// Wrapper for creating a new object /// - /// The type of item from the enum - /// The of the newly created object - /// An object with the type and id passed + /// The type of item from the enum + /// The of the newly created object + /// An object with the type and id passed public static InventoryItem CreateInventoryItem(InventoryType type, UUID id) { switch (type) diff --git a/LibreMetaverse/LockingDictionary.cs b/LibreMetaverse/LockingDictionary.cs index 722d5bc7..af3a7022 100644 --- a/LibreMetaverse/LockingDictionary.cs +++ b/LibreMetaverse/LockingDictionary.cs @@ -128,9 +128,9 @@ namespace OpenMetaverse /// /// Initializes a new instance of the Class /// with the specified key/value, has its initial values copied from the specified - /// + /// /// - /// + /// /// to copy initial values from /// /// @@ -152,7 +152,7 @@ namespace OpenMetaverse } /// - /// Initializes a new instance of + /// Initializes a new instance of /// with the specified key/value, With its initial capacity specified. /// /// Initial size of dictionary @@ -186,7 +186,7 @@ namespace OpenMetaverse /// if (Client.Network.CurrentSim.ObjectsAvatars.TryGetValue(Client.Self.AgentID, out av)) /// Console.WriteLine("Found Avatar {0}", av.Name); /// - /// + /// /// public bool TryGetValue(TKey key, out TValue value) { @@ -270,8 +270,8 @@ namespace OpenMetaverse return found; } - /// Perform an on each entry in - /// to perform + /// Perform an on each entry in + /// to perform /// /// /// // Iterates over the ObjectsPrimitives LockingDictionary and prints out some information. @@ -297,8 +297,8 @@ namespace OpenMetaverse } } - /// Perform an on each key of an to perform + /// Perform an on each key of an to perform public void ForEach(Action action) { lock (Dictionary) @@ -311,9 +311,9 @@ namespace OpenMetaverse } /// - /// Perform an on each KeyValuePair of + /// Perform an on each KeyValuePair of /// - /// to perform + /// to perform public void ForEach(Action> action) { lock (Dictionary) diff --git a/LibreMetaverse/Logger.cs b/LibreMetaverse/Logger.cs index a2356c48..890671a2 100644 --- a/LibreMetaverse/Logger.cs +++ b/LibreMetaverse/Logger.cs @@ -45,7 +45,7 @@ namespace OpenMetaverse /// the library /// /// Data being logged - /// The severity of the log entry from + /// The severity of the log entry from public delegate void LogCallback(object message, Helpers.LogLevel level); /// Triggered whenever a message is logged. If this is left diff --git a/LibreMetaverse/Login.cs b/LibreMetaverse/Login.cs index 35af6007..0f02730a 100644 --- a/LibreMetaverse/Login.cs +++ b/LibreMetaverse/Login.cs @@ -251,8 +251,8 @@ namespace OpenMetaverse /// Instantiate LoginParams /// /// Use this constructor if Application supports multi-factor authentication - /// Instance of - /// Instance of + /// Instance of + /// Instance of /// Login channel (application name) /// Client version, as application name + version number public LoginParams(GridClient client, LoginCredential credential, string channel, string version) @@ -274,8 +274,8 @@ namespace OpenMetaverse /// Instantiate LoginParams /// /// Use this constructor if Application supports multi-factor authentication - /// Instance of - /// Instance of + /// Instance of + /// Instance of /// Login channel (application name) /// Client version, as application name + version number /// Address of login service @@ -413,7 +413,7 @@ namespace OpenMetaverse /// /// Parse LLSD Login Reply Data /// - /// An + /// An /// containing the login response data /// XML-RPC logins do not require this as XML-RPC.NET /// automatically populates the struct properly using attributes @@ -1205,7 +1205,7 @@ namespace OpenMetaverse /// Account password /// Client application name (channel) /// Version string (typically x.x.x) - /// A populated object containing sane defaults + /// A populated object containing sane defaults public LoginParams DefaultLoginParams(string firstName, string lastName, string password, string channel, string version) { @@ -1839,9 +1839,9 @@ namespace OpenMetaverse /// /// Handle response from LLSD login replies /// - /// Server response as + /// Server response as /// Payload response data - /// Any returned from the request + /// Any returned from the request private void LoginReplyLLSDHandler(HttpResponseMessage response, byte[] responseData, Exception error) { if (error != null) diff --git a/LibreMetaverse/Messages/LindenMessages.cs b/LibreMetaverse/Messages/LindenMessages.cs index 6e6e7205..11f17b62 100644 --- a/LibreMetaverse/Messages/LindenMessages.cs +++ b/LibreMetaverse/Messages/LindenMessages.cs @@ -705,7 +705,7 @@ namespace OpenMetaverse.Messages.Linden /// /// A number which increments by 1, starting at 0 for each ParcelProperties request. /// Can be overriden by specifying the sequenceID with the ParcelPropertiesRequest being sent. - /// a Negative number indicates the action in has occurred. + /// a Negative number indicates the action in has occurred. /// public int SequenceID; /// Maximum primitives across the entire simulator @@ -928,23 +928,23 @@ namespace OpenMetaverse.Messages.Linden } } - /// A message sent from the viewer to the simulator to updated a specific parcels settings + /// A message sent from the viewer to the simulator to update a specific parcels settings public class ParcelPropertiesUpdateMessage : IMessage { - /// The of the agent authorized to purchase this - /// parcel of land or a NULL if the sale is authorized to anyone + /// The of the agent authorized to purchase this + /// parcel of land or a NULL if the sale is authorized to anyone public UUID AuthBuyerID; - /// true to enable auto scaling of the parcel media + /// true to enable auto-scaling of the parcel media public bool MediaAutoScale; /// The category of this parcel used when search is enabled to restrict /// search results public ParcelCategory Category; /// A string containing the description to set public string Desc; - /// The of the which allows for additional + /// The of the which allows for additional /// powers and restrictions. public UUID GroupID; - /// The which specifies how avatars which teleport + /// The which specifies how avatars which teleport /// to this parcel are handled public LandingType Landing; /// The LocalID of the parcel to update settings on @@ -1566,9 +1566,9 @@ namespace OpenMetaverse.Messages.Linden public bool AcceptNotices; /// The agents tier contribution to the group public int Contribution; - /// The Groups + /// The Groups public UUID GroupID; - /// The of the groups insignia + /// The of the groups insignia public UUID GroupInsigniaID; /// The user title from the group public string GroupTitle; @@ -1587,10 +1587,10 @@ namespace OpenMetaverse.Messages.Linden public bool ListInProfile; } - /// An array containing information + /// An array containing information /// for each the agent is a member of public GroupData[] GroupDataBlock; - /// An array containing information + /// An array containing information /// for each the agent is a member of public NewGroupData[] NewGroupDataBlock; @@ -2176,9 +2176,9 @@ namespace OpenMetaverse.Messages.Linden /// The Asset ID of the script public UUID ItemID; /// True of the script is compiled/ran using the mono interpreter, false indicates it - /// uses the older less efficient lsl2 interprter + /// uses the older less efficient lsl2 interpreter public bool Mono; - /// The Task containing the scripts + /// The Task containing the scripts public UUID ObjectID; /// true of the script is in a running state public bool Running; @@ -2266,9 +2266,9 @@ namespace OpenMetaverse.Messages.Linden /// public class UpdateNotecardTaskInventoryMessage : IMessage { - /// The of the Task containing the notecard asset to update + /// The of the Task containing the notecard asset to update public UUID TaskID; - /// The notecard assets contained in the tasks inventory + /// The notecard assets contained in the tasks inventory public UUID ItemID; /// diff --git a/LibreMetaverse/ObjectManager.cs b/LibreMetaverse/ObjectManager.cs index 86a52568..77dd92fa 100644 --- a/LibreMetaverse/ObjectManager.cs +++ b/LibreMetaverse/ObjectManager.cs @@ -1054,14 +1054,14 @@ namespace OpenMetaverse /// /// Create (rez) a new prim object in a simulator /// - /// A reference to the object to place the object in + /// A reference to the object to place the object in /// Data describing the prim object to rez /// Group ID that this prim will be set to, or UUID.Zero if you /// do not want the object to be associated with a specific group /// An approximation of the position at which to rez the prim /// Scale vector to size this prim /// Rotation quaternion to rotate this prim - /// Specify the + /// Specify the /// Due to the way client prim rezzing is done on the server, /// the requested position for an object is only close to where the prim /// actually ends up. If you desire exact placement you'll need to @@ -1119,12 +1119,12 @@ namespace OpenMetaverse /// /// Rez a Linden tree /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The size of the tree /// The rotation of the tree /// The position of the tree /// The Type of tree - /// The of the group to set the tree to, + /// The of the group to set the tree to, /// or UUID.Zero if no group is to be set /// true to use the "new" Linden trees, false to use the old public void AddTree(Simulator simulator, Vector3 scale, Quaternion rotation, Vector3 position, @@ -1159,12 +1159,12 @@ namespace OpenMetaverse /// /// Rez grass and ground cover /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The size of the grass /// The rotation of the grass /// The position of the grass - /// The type of grass from the enum - /// The of the group to set the tree to, + /// The type of grass from the enum + /// The of the group to set the tree to, /// or UUID.Zero if no group is to be set public void AddGrass(Simulator simulator, Vector3 scale, Quaternion rotation, Vector3 position, Grass grassType, UUID groupOwner) @@ -1198,7 +1198,7 @@ namespace OpenMetaverse /// /// Set the textures to apply to the faces of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The texture data to apply public void SetTextures(Simulator simulator, uint localID, Primitive.TextureEntry textures) @@ -1209,7 +1209,7 @@ namespace OpenMetaverse /// /// Set the textures to apply to the faces of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The texture data to apply /// A media URL (not used) @@ -1238,9 +1238,9 @@ namespace OpenMetaverse /// /// Set the Light data on an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in - /// object containing the data to set + /// object containing the data to set public void SetLight(Simulator simulator, uint localID, Primitive.LightData light) { ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket @@ -1269,9 +1269,9 @@ namespace OpenMetaverse /// /// Set the flexible data on an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in - /// A object containing the data to set + /// A object containing the data to set public void SetFlexible(Simulator simulator, uint localID, Primitive.FlexibleData flexible) { ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket @@ -1299,9 +1299,9 @@ namespace OpenMetaverse /// /// Set the sculptie texture and data on an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in - /// A object containing the data to set + /// A object containing the data to set public void SetSculpt(Simulator simulator, uint localID, Primitive.SculptData sculpt) { ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket @@ -1350,7 +1350,7 @@ namespace OpenMetaverse /// /// Unset additional primitive parameters on an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The extra parameters to set public void SetExtraParamOff(Simulator simulator, uint localID, ExtraParamType type) @@ -1380,7 +1380,7 @@ namespace OpenMetaverse /// /// Link multiple prims into a linkset /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to link /// The last object in the array will be the root object of the linkset public void LinkPrims(Simulator simulator, List localIDs) @@ -1409,7 +1409,7 @@ namespace OpenMetaverse /// /// Delink/Unlink multiple prims from a linkset /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to delink public void DelinkPrims(Simulator simulator, List localIDs) { @@ -1440,7 +1440,7 @@ namespace OpenMetaverse /// /// Change the rotation of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new rotation of the object public void SetRotation(Simulator simulator, uint localID, Quaternion rotation) @@ -1466,7 +1466,7 @@ namespace OpenMetaverse /// /// Set the name of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// A string containing the new name of the object public void SetName(Simulator simulator, uint localID, string name) @@ -1477,7 +1477,7 @@ namespace OpenMetaverse /// /// Set the name of multiple objects /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to change the name of /// An array which contains the new names of the objects public void SetNames(Simulator simulator, uint[] localIDs, string[] names) @@ -1507,7 +1507,7 @@ namespace OpenMetaverse /// /// Set the description of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// A string containing the new description of the object public void SetDescription(Simulator simulator, uint localID, string description) @@ -1518,7 +1518,7 @@ namespace OpenMetaverse /// /// Set the descriptions of multiple objects /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to change the description of /// An array which contains the new descriptions of the objects public void SetDescriptions(Simulator simulator, uint[] localIDs, string[] descriptions) @@ -1548,7 +1548,7 @@ namespace OpenMetaverse /// /// Attach an object to this avatar /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The point on the avatar the object will be attached /// The rotation of the attached object @@ -1577,7 +1577,7 @@ namespace OpenMetaverse /// /// Drop an attached object from this avatar /// - /// A reference to the + /// A reference to the /// object where the objects reside. This will always be the simulator the avatar is currently in /// /// The object's ID which is local to the simulator the object is in @@ -1603,7 +1603,7 @@ namespace OpenMetaverse /// /// Detach an object from yourself /// - /// A reference to the + /// A reference to the /// object where the objects reside /// /// This will always be the simulator the avatar is currently in @@ -1635,7 +1635,7 @@ namespace OpenMetaverse /// /// Change the position of an object, Will change position of entire linkset /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new position of the object public void SetPosition(Simulator simulator, uint localID, Vector3 position) @@ -1646,7 +1646,7 @@ namespace OpenMetaverse /// /// Change the position of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new position of the object /// if true, will change position of (this) child prim only, not entire linkset @@ -1663,7 +1663,7 @@ namespace OpenMetaverse /// /// Change the Scale (size) of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new scale of the object /// If true, will change scale of this prim only, not entire linkset @@ -1684,7 +1684,7 @@ namespace OpenMetaverse /// /// Change the Rotation of an object that is either a child or a whole linkset /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new scale of the object /// If true, will change rotation of this prim only, not entire linkset @@ -1718,10 +1718,10 @@ namespace OpenMetaverse /// /// Send a Multiple Object Update packet to change the size, scale or rotation of a primitive /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new rotation, size, or position of the target object - /// The flags from the Enum + /// The flags from the Enum public void UpdateObject(Simulator simulator, uint localID, Vector3 data, UpdateType type) { MultipleObjectUpdatePacket multiObjectUpdate = new MultipleObjectUpdatePacket @@ -1748,9 +1748,9 @@ namespace OpenMetaverse /// Deed an object (prim) to a group, Object must be shared with group which /// can be accomplished with SetPermissions() /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in - /// The of the group to deed the object to + /// The of the group to deed the object to public void DeedObject(Simulator simulator, uint localID, UUID groupOwner) { ObjectOwnerPacket objDeedPacket = new ObjectOwnerPacket @@ -1782,9 +1782,9 @@ namespace OpenMetaverse /// Deed multiple objects (prims) to a group, Objects must be shared with group which /// can be accomplished with SetPermissions() /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// An array which contains the IDs of the objects to deed - /// The of the group to deed the object to + /// The of the group to deed the object to public void DeedObjects(Simulator simulator, List localIDs, UUID groupOwner) { ObjectOwnerPacket packet = new ObjectOwnerPacket @@ -1817,7 +1817,7 @@ namespace OpenMetaverse /// /// Set the permissions on multiple objects /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to set the permissions on /// The new Who mask to set /// Which permission to modify @@ -1857,7 +1857,7 @@ namespace OpenMetaverse /// /// Request additional properties for an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// public void RequestObjectPropertiesFamily(Simulator simulator, UUID objectID) { @@ -1867,7 +1867,7 @@ namespace OpenMetaverse /// /// Request additional properties for an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// Absolute UUID of the object /// Whether to require server acknowledgement of this request public void RequestObjectPropertiesFamily(Simulator simulator, UUID objectID, bool reliable) @@ -1896,7 +1896,7 @@ namespace OpenMetaverse /// /// Set the ownership of a list of objects to the specified group /// - /// A reference to the object where the objects reside + /// A reference to the object where the objects reside /// An array which contains the IDs of the objects to set the group id on /// The Groups ID public void SetObjectsGroup(Simulator simulator, List localIds, UUID groupID) @@ -1959,7 +1959,7 @@ namespace OpenMetaverse /// /// UUID of the prim /// Array the length of prims number of faces. Null on face indexes where there is - /// no media, on faces which contain the media + /// no media, on faces which contain the media /// Simulator in which prim is located public void UpdateObjectMedia(UUID primID, MediaEntry[] faceMedia, Simulator sim) { @@ -3397,7 +3397,7 @@ namespace OpenMetaverse /// Setup construction data for a basic primitive shape /// /// Primitive shape to construct - /// Construction data that can be plugged into a + /// Construction data that can be plugged into a public static Primitive.ConstructionData BuildBasicShape(PrimType type) { Primitive.ConstructionData prim = new Primitive.ConstructionData @@ -3524,7 +3524,7 @@ namespace OpenMetaverse /// /// Set the Shape data of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// Data describing the prim shape public void SetShape(Simulator simulator, uint localID, Primitive.ConstructionData prim) @@ -3568,7 +3568,7 @@ namespace OpenMetaverse /// /// Set the Material data of an object /// - /// A reference to the object where the object resides + /// A reference to the object where the object resides /// The objects ID which is local to the simulator the object is in /// The new material of the object public void SetMaterial(Simulator simulator, uint localID, Material material) diff --git a/LibreMetaverse/ObservableDictionary.cs b/LibreMetaverse/ObservableDictionary.cs index ec4e2c8f..723527bc 100644 --- a/LibreMetaverse/ObservableDictionary.cs +++ b/LibreMetaverse/ObservableDictionary.cs @@ -125,15 +125,15 @@ namespace OpenMetaverse /// Internal dictionary that this class wraps around. Do not /// modify or enumerate the contents of this dictionary without locking - private Dictionary Dictionary; + private readonly Dictionary Dictionary; /// - /// Gets the number of Key/Value pairs contained in the + /// Gets the number of Key/Value pairs contained in the /// - public int Count { get { return Dictionary.Count; } } + public int Count => Dictionary.Count; /// - /// Initializes a new instance of the Class + /// Initializes a new instance of the Class /// with the specified key/value, has the default initial capacity. /// /// @@ -149,7 +149,7 @@ namespace OpenMetaverse } /// - /// Initializes a new instance of the Class + /// Initializes a new instance of the Class /// with the specified key/value, With its initial capacity specified. /// /// Initial size of dictionary @@ -167,7 +167,7 @@ namespace OpenMetaverse } /// - /// Try to get entry from the with specified key + /// Try to get entry from the with specified key /// /// Key to use for lookup /// Value returned @@ -210,9 +210,9 @@ namespace OpenMetaverse return default(TValue); } - /// Find All items in an + /// Find All items in an /// return matching items. - /// a containing found items. + /// a containing found items. /// /// Find All prims within 20 meters and store them in a List /// @@ -237,9 +237,9 @@ namespace OpenMetaverse return found; } - /// Find All items in an + /// Find All items in an /// return matching keys. - /// a containing found keys. + /// a containing found keys. /// /// Find All keys which also exist in another dictionary /// diff --git a/LibreMetaverse/ParcelManager.cs b/LibreMetaverse/ParcelManager.cs index 960d7d53..67fc3b53 100644 --- a/LibreMetaverse/ParcelManager.cs +++ b/LibreMetaverse/ParcelManager.cs @@ -402,7 +402,7 @@ namespace OpenMetaverse { /// Global Key of record public UUID ID; - /// Parcel Owners + /// Parcel Owners public UUID OwnerID; /// Name field of parcel, limited to 128 characters public string Name; @@ -422,7 +422,7 @@ namespace OpenMetaverse public float GlobalZ; /// Name of simulator parcel is located in public string SimName; - /// Texture of parcels display picture + /// Texture of parcels display picture public UUID SnapshotID; /// Float representing calculated traffic based on time spent on parcel by avatars public float Dwell; @@ -735,7 +735,7 @@ namespace OpenMetaverse /// public struct ParcelAccessEntry { - /// Agents + /// Agents public UUID AgentID; /// public DateTime Time; @@ -748,7 +748,7 @@ namespace OpenMetaverse /// public struct ParcelPrimOwners { - /// Prim Owners + /// Prim Owners public UUID OwnerID; /// True of owner is group public bool IsGroupOwned; @@ -1241,7 +1241,7 @@ namespace OpenMetaverse /// The Simulator the parcel is located in /// The parcels region specific local ID /// true if this parcel is being purchased by a group - /// The groups + /// The groups /// true to remove tier contribution if purchase is successful /// The parcels size /// The purchase price of the parcel @@ -1303,7 +1303,7 @@ namespace OpenMetaverse /// /// The simulator the parcel is in /// The parcels region specific local ID - /// The groups + /// The groups public void DeedToGroup(Simulator simulator, int localID, UUID groupID) { ParcelDeedToGroupPacket request = new ParcelDeedToGroupPacket @@ -1350,8 +1350,8 @@ namespace OpenMetaverse /// /// Simulator parcel is in /// The parcels region specific local ID - /// the type of objects to return, - /// A list containing object owners s to return + /// the type of objects to return, + /// A list containing object owners s to return public void ReturnObjects(Simulator simulator, int localID, ObjectReturnType type, List ownerIDs) { ParcelReturnObjectsPacket request = new ParcelReturnObjectsPacket @@ -1602,7 +1602,7 @@ namespace OpenMetaverse /// Owners, Others, Etc /// List containing keys of avatars objects to select; /// if List is null will return Objects of type selectType - /// Response data is returned in the event + /// Response data is returned in the event public void RequestSelectObjects(int localID, ObjectReturnType selectType, UUID ownerID) { ParcelSelectObjectsPacket select = new ParcelSelectObjectsPacket(); diff --git a/LibreMetaverse/Primitives/ParticleSystem.cs b/LibreMetaverse/Primitives/ParticleSystem.cs index 258d391e..0df8549c 100644 --- a/LibreMetaverse/Primitives/ParticleSystem.cs +++ b/LibreMetaverse/Primitives/ParticleSystem.cs @@ -133,7 +133,7 @@ namespace OpenMetaverse /// and serialization breaks unless there is a flag for every /// possible bit so it is left as an unsigned integer public uint PartFlags; - /// pattern of particles + /// pattern of particles public SourcePattern Pattern; /// A representing the maximimum age (in seconds) particle will be displayed /// Maximum value is 30 seconds @@ -167,7 +167,7 @@ namespace OpenMetaverse public UUID Texture; /// The Key of the specified target object or avatar particles will follow public UUID Target; - /// Flags of particle from + /// Flags of particle from public ParticleDataFlags PartDataFlags; /// Max Age particle system will emit particles for public float PartMaxAge; diff --git a/LibreMetaverse/Primitives/Primitive.cs b/LibreMetaverse/Primitives/Primitive.cs index 2a6b9f26..df901490 100644 --- a/LibreMetaverse/Primitives/Primitive.cs +++ b/LibreMetaverse/Primitives/Primitive.cs @@ -689,7 +689,7 @@ namespace OpenMetaverse /// /// Set the properties that are set in an ObjectPropertiesFamily packet /// - /// that has + /// that has /// been partially filled by an ObjectPropertiesFamily packet public void SetFamilyProperties(ObjectProperties props) { diff --git a/LibreMetaverse/Repeat.cs b/LibreMetaverse/Repeat.cs index 21a46db2..55e7ce31 100644 --- a/LibreMetaverse/Repeat.cs +++ b/LibreMetaverse/Repeat.cs @@ -33,7 +33,7 @@ namespace LibreMetaverse internal static class Repeat { /// - /// Execute a given at a given interval in a loop + /// Execute a given at a given interval in a loop /// /// Interval for executing action /// Essentially the action you wish to execute diff --git a/LibreMetaverse/Simulator.cs b/LibreMetaverse/Simulator.cs index 6517c9ee..5514dfad 100644 --- a/LibreMetaverse/Simulator.cs +++ b/LibreMetaverse/Simulator.cs @@ -274,7 +274,7 @@ namespace OpenMetaverse /// Human readable name given to the simulator public string Name = string.Empty; /// A 64x64 grid of parcel coloring values. The values stored - /// in this array are of the type + /// in this array are of the type public byte[] ParcelOverlay = new byte[4096]; /// public int ParcelOverlaysReceived; @@ -558,7 +558,7 @@ namespace OpenMetaverse /// /// Constructor /// - /// Reference to the object + /// Reference to the object /// IPEndPoint of the simulator /// Region handle for the simulator /// Region size X diff --git a/LibreMetaverse/TexturePipeline.cs b/LibreMetaverse/TexturePipeline.cs index 206c352e..cd042bde 100644 --- a/LibreMetaverse/TexturePipeline.cs +++ b/LibreMetaverse/TexturePipeline.cs @@ -50,7 +50,7 @@ namespace OpenMetaverse Progress, /// A request that has received all packets back from the simulator Finished, - /// A request that has taken longer than + /// A request that has taken longer than /// to download OR the initial packet containing the packet information was never received Timeout, /// The texture request was aborted by request of the agent @@ -72,9 +72,9 @@ namespace OpenMetaverse /// /// Texture request download handler, allows a configurable number of download slots which manage multiple - /// concurrent texture downloads from the + /// concurrent texture downloads from the /// - /// This class makes full use of the internal + /// This class makes full use of the internal /// system for full texture downloads. public class TexturePipeline { @@ -92,7 +92,7 @@ namespace OpenMetaverse /// private class TaskInfo { - /// The current which identifies the current status of the request + /// The current which identifies the current status of the request public TextureRequestState State; /// The Unique Request ID, This is also the Asset ID of the texture being requested public UUID RequestID; @@ -102,7 +102,7 @@ namespace OpenMetaverse public ImageType Type; /// The callback to fire when the request is complete, will include - /// the and the + /// the and the /// object containing the result data public List Callbacks; /// If true, indicates the callback will be fired whenever new data is returned from the simulator. diff --git a/LibreMetaverse/UserReport.cs b/LibreMetaverse/UserReport.cs index 1de927a5..17fc8aab 100644 --- a/LibreMetaverse/UserReport.cs +++ b/LibreMetaverse/UserReport.cs @@ -46,13 +46,13 @@ namespace LibreMetaverse CsRequestReport = 4 } - /// A reference to the current instance + /// A reference to the current instance private GridClient Client; /// /// Construct a new instance of the UserReport class /// - /// A reference to the current instance + /// A reference to the current instance UserReport(GridClient client) { Client = client;