Miko/libremetaverse
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Heroic attempt to correct the use of <seealso cref=""/>

Browse Source
This commit is contained in:
cinder
2025-01-21 07:27:05 -06:00
parent 64f3745000
commit f005031b51
30 changed files with 315 additions and 315 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
LibreMetaverse/ObjectManager.cs
View File

@@ -1054,14 +1054,14 @@ namespace OpenMetaverse
/// <summary>
/// Create (rez) a new prim object in a simulator
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="Simulator"/> object to place the object in</param>
/// <param name="simulator">A reference to the <see cref="Simulator"/> object to place the object in</param>
/// <param name="prim">Data describing the prim object to rez</param>
/// <param name="groupID">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</param>
/// <param name="position">An approximation of the position at which to rez the prim</param>
/// <param name="scale">Scale vector to size this prim</param>
/// <param name="rotation">Rotation quaternion to rotate this prim</param>
/// <param name="createFlags">Specify the <seealso cref="PrimFlags"/></param>
/// <param name="createFlags">Specify the <see cref="PrimFlags"/></param>
/// <remarks>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
/// <summary>
/// Rez a Linden tree
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="scale">The size of the tree</param>
/// <param name="rotation">The rotation of the tree</param>
/// <param name="position">The position of the tree</param>
/// <param name="treeType">The Type of tree</param>
/// <param name="groupOwner">The <seealso cref="UUID"/> of the group to set the tree to,
/// <param name="groupOwner">The <see cref="UUID"/> of the group to set the tree to,
/// or UUID.Zero if no group is to be set</param>
/// <param name="newTree">true to use the "new" Linden trees, false to use the old</param>
public void AddTree(Simulator simulator, Vector3 scale, Quaternion rotation, Vector3 position,
@@ -1159,12 +1159,12 @@ namespace OpenMetaverse
/// <summary>
/// Rez grass and ground cover
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="scale">The size of the grass</param>
/// <param name="rotation">The rotation of the grass</param>
/// <param name="position">The position of the grass</param>
/// <param name="grassType">The type of grass from the <seealso cref="Grass"/> enum</param>
/// <param name="groupOwner">The <seealso cref="UUID"/> of the group to set the tree to,
/// <param name="grassType">The type of grass from the <see cref="Grass"/> enum</param>
/// <param name="groupOwner">The <see cref="UUID"/> of the group to set the tree to,
/// or UUID.Zero if no group is to be set</param>
public void AddGrass(Simulator simulator, Vector3 scale, Quaternion rotation, Vector3 position,
Grass grassType, UUID groupOwner)
@@ -1198,7 +1198,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the textures to apply to the faces of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="textures">The texture data to apply</param>
public void SetTextures(Simulator simulator, uint localID, Primitive.TextureEntry textures)
@@ -1209,7 +1209,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the textures to apply to the faces of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="textures">The texture data to apply</param>
/// <param name="mediaUrl">A media URL (not used)</param>
@@ -1238,9 +1238,9 @@ namespace OpenMetaverse
/// <summary>
/// Set the Light data on an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="light"><seealso cref="Primitive.LightData"/> object containing the data to set</param>
/// <param name="light"><see cref="Primitive.LightData"/> object containing the data to set</param>
public void SetLight(Simulator simulator, uint localID, Primitive.LightData light)
{
ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket
@@ -1269,9 +1269,9 @@ namespace OpenMetaverse
/// <summary>
/// Set the flexible data on an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="flexible">A <seealso cref="Primitive.FlexibleData"/> object containing the data to set</param>
/// <param name="flexible">A <see cref="Primitive.FlexibleData"/> object containing the data to set</param>
public void SetFlexible(Simulator simulator, uint localID, Primitive.FlexibleData flexible)
{
ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket
@@ -1299,9 +1299,9 @@ namespace OpenMetaverse
/// <summary>
/// Set the sculptie texture and data on an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="sculpt">A <seealso cref="Primitive.SculptData"/> object containing the data to set</param>
/// <param name="sculpt">A <see cref="Primitive.SculptData"/> object containing the data to set</param>
public void SetSculpt(Simulator simulator, uint localID, Primitive.SculptData sculpt)
{
ObjectExtraParamsPacket extra = new ObjectExtraParamsPacket
@@ -1350,7 +1350,7 @@ namespace OpenMetaverse
/// <summary>
/// Unset additional primitive parameters on an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="type">The extra parameters to set</param>
public void SetExtraParamOff(Simulator simulator, uint localID, ExtraParamType type)
@@ -1380,7 +1380,7 @@ namespace OpenMetaverse
/// <summary>
/// Link multiple prims into a linkset
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIDs">An array which contains the IDs of the objects to link</param>
/// <remarks>The last object in the array will be the root object of the linkset</remarks>
public void LinkPrims(Simulator simulator, List<uint> localIDs)
@@ -1409,7 +1409,7 @@ namespace OpenMetaverse
/// <summary>
/// Delink/Unlink multiple prims from a linkset
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIDs">An array which contains the IDs of the objects to delink</param>
public void DelinkPrims(Simulator simulator, List<uint> localIDs)
{
@@ -1440,7 +1440,7 @@ namespace OpenMetaverse
/// <summary>
/// Change the rotation of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="rotation">The new rotation of the object</param>
public void SetRotation(Simulator simulator, uint localID, Quaternion rotation)
@@ -1466,7 +1466,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the name of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="name">A string containing the new name of the object</param>
public void SetName(Simulator simulator, uint localID, string name)
@@ -1477,7 +1477,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the name of multiple objects
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIDs">An array which contains the IDs of the objects to change the name of</param>
/// <param name="names">An array which contains the new names of the objects</param>
public void SetNames(Simulator simulator, uint[] localIDs, string[] names)
@@ -1507,7 +1507,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the description of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="description">A string containing the new description of the object</param>
public void SetDescription(Simulator simulator, uint localID, string description)
@@ -1518,7 +1518,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the descriptions of multiple objects
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIDs">An array which contains the IDs of the objects to change the description of</param>
/// <param name="descriptions">An array which contains the new descriptions of the objects</param>
public void SetDescriptions(Simulator simulator, uint[] localIDs, string[] descriptions)
@@ -1548,7 +1548,7 @@ namespace OpenMetaverse
/// <summary>
/// Attach an object to this avatar
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="attachPoint">The point on the avatar the object will be attached</param>
/// <param name="rotation">The rotation of the attached object</param>
@@ -1577,7 +1577,7 @@ namespace OpenMetaverse
/// <summary>
/// Drop an attached object from this avatar
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/>
/// object where the objects reside. This will always be the simulator the avatar is currently in
/// </param>
/// <param name="localID">The object's ID which is local to the simulator the object is in</param>
@@ -1603,7 +1603,7 @@ namespace OpenMetaverse
/// <summary>
/// Detach an object from yourself
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/>
/// object where the objects reside
///
/// This will always be the simulator the avatar is currently in
@@ -1635,7 +1635,7 @@ namespace OpenMetaverse
/// <summary>
/// Change the position of an object, Will change position of entire linkset
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="position">The new position of the object</param>
public void SetPosition(Simulator simulator, uint localID, Vector3 position)
@@ -1646,7 +1646,7 @@ namespace OpenMetaverse
/// <summary>
/// Change the position of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="position">The new position of the object</param>
/// <param name="childOnly">if true, will change position of (this) child prim only, not entire linkset</param>
@@ -1663,7 +1663,7 @@ namespace OpenMetaverse
/// <summary>
/// Change the Scale (size) of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="scale">The new scale of the object</param>
/// <param name="childOnly">If true, will change scale of this prim only, not entire linkset</param>
@@ -1684,7 +1684,7 @@ namespace OpenMetaverse
/// <summary>
/// Change the Rotation of an object that is either a child or a whole linkset
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="quat">The new scale of the object</param>
/// <param name="childOnly">If true, will change rotation of this prim only, not entire linkset</param>
@@ -1718,10 +1718,10 @@ namespace OpenMetaverse
/// <summary>
/// Send a Multiple Object Update packet to change the size, scale or rotation of a primitive
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="data">The new rotation, size, or position of the target object</param>
/// <param name="type">The flags from the <seealso cref="UpdateType"/> Enum</param>
/// <param name="type">The flags from the <see cref="UpdateType"/> Enum</param>
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()
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="groupOwner">The <seealso cref="UUID"/> of the group to deed the object to</param>
/// <param name="groupOwner">The <see cref="UUID"/> of the group to deed the object to</param>
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()
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localIDs">An array which contains the IDs of the objects to deed</param>
/// <param name="groupOwner">The <seealso cref="UUID"/> of the group to deed the object to</param>
/// <param name="groupOwner">The <see cref="UUID"/> of the group to deed the object to</param>
public void DeedObjects(Simulator simulator, List<uint> localIDs, UUID groupOwner)
{
ObjectOwnerPacket packet = new ObjectOwnerPacket
@@ -1817,7 +1817,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the permissions on multiple objects
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIDs">An array which contains the IDs of the objects to set the permissions on</param>
/// <param name="who">The new Who mask to set</param>
/// <param name="permissions">Which permission to modify</param>
@@ -1857,7 +1857,7 @@ namespace OpenMetaverse
/// <summary>
/// Request additional properties for an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="objectID"></param>
public void RequestObjectPropertiesFamily(Simulator simulator, UUID objectID)
{
@@ -1867,7 +1867,7 @@ namespace OpenMetaverse
/// <summary>
/// Request additional properties for an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="objectID">Absolute UUID of the object</param>
/// <param name="reliable">Whether to require server acknowledgement of this request</param>
public void RequestObjectPropertiesFamily(Simulator simulator, UUID objectID, bool reliable)
@@ -1896,7 +1896,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the ownership of a list of objects to the specified group
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the objects reside</param>
/// <param name="localIds">An array which contains the IDs of the objects to set the group id on</param>
/// <param name="groupID">The Groups ID</param>
public void SetObjectsGroup(Simulator simulator, List<uint> localIds, UUID groupID)
@@ -1959,7 +1959,7 @@ namespace OpenMetaverse
/// </summary>
/// <param name="primID">UUID of the prim</param>
/// <param name="faceMedia">Array the length of prims number of faces. Null on face indexes where there is
/// no media, <seealso cref="MediaEntry"/> on faces which contain the media</param>
/// no media, <see cref="MediaEntry"/> on faces which contain the media</param>
/// <param name="sim">Simulator in which prim is located</param>
public void UpdateObjectMedia(UUID primID, MediaEntry[] faceMedia, Simulator sim)
{
@@ -3397,7 +3397,7 @@ namespace OpenMetaverse
/// Setup construction data for a basic primitive shape
/// </summary>
/// <param name="type">Primitive shape to construct</param>
/// <returns>Construction data that can be plugged into a <seealso cref="Primitive"/></returns>
/// <returns>Construction data that can be plugged into a <see cref="Primitive"/></returns>
public static Primitive.ConstructionData BuildBasicShape(PrimType type)
{
Primitive.ConstructionData prim = new Primitive.ConstructionData
@@ -3524,7 +3524,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the Shape data of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="prim">Data describing the prim shape</param>
public void SetShape(Simulator simulator, uint localID, Primitive.ConstructionData prim)
@@ -3568,7 +3568,7 @@ namespace OpenMetaverse
/// <summary>
/// Set the Material data of an object
/// </summary>
/// <param name="simulator">A reference to the <seealso cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="simulator">A reference to the <see cref="OpenMetaverse.Simulator"/> object where the object resides</param>
/// <param name="localID">The objects ID which is local to the simulator the object is in</param>
/// <param name="material">The new material of the object</param>
public void SetMaterial(Simulator simulator, uint localID, Material material)