ILandChannel.cs 4.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public interface ILandChannel
  33. {
  34. /// <summary>
  35. /// Get all parcels
  36. /// </summary>
  37. /// <returns></returns>
  38. List<ILandObject> AllParcels();
  39. /// <summary>
  40. /// Get the parcel at the specified point
  41. /// </summary>
  42. /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
  43. /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
  44. /// <returns>Land object at the point supplied</returns>
  45. ILandObject GetLandObject(int x, int y);
  46. /// <summary>
  47. /// Get the parcel at the specified point
  48. /// </summary>
  49. /// <param name="x">Value between 0 - 256 on the x axis of the point</param>
  50. /// <param name="y">Value between 0 - 256 on the y axis of the point</param>
  51. /// <returns>Land object at the point supplied</returns>
  52. ILandObject GetLandObject(float x, float y);
  53. /// <summary>
  54. /// Get the parcel at the specified point
  55. /// </summary>
  56. /// <param name="position">Vector where x and y components are between 0 and 256. z component is ignored.</param>
  57. /// <returns>Land object at the point supplied</returns>
  58. ILandObject GetLandObject(Vector3 position);
  59. /// <summary>
  60. /// Get the parcels near the specified point
  61. /// </summary>
  62. /// <param name="position"></param>
  63. /// <returns></returns>
  64. List<ILandObject> ParcelsNearPoint(Vector3 position);
  65. /// <summary>
  66. /// Get the parcel given the land's local id.
  67. /// </summary>
  68. /// <param name="localID"></param>
  69. /// <returns></returns>
  70. ILandObject GetLandObject(int localID);
  71. /// <summary>
  72. /// Clear the land channel of all parcels.
  73. /// </summary>
  74. /// <param name="setupDefaultParcel">
  75. /// If true, set up a default parcel covering the whole region owned by the estate owner.
  76. /// </param>
  77. void Clear(bool setupDefaultParcel);
  78. bool IsForcefulBansAllowed();
  79. void UpdateLandObject(int localID, LandData data);
  80. void ReturnObjectsInParcel(int localID, uint returnType, UUID[] agentIDs, UUID[] taskIDs, IClientAPI remoteClient);
  81. void setParcelObjectMaxOverride(overrideParcelMaxPrimCountDelegate overrideDel);
  82. void setSimulatorObjectMaxOverride(overrideSimulatorMaxPrimCountDelegate overrideDel);
  83. void SetParcelOtherCleanTime(IClientAPI remoteClient, int localID, int otherCleanTime);
  84. void Join(int start_x, int start_y, int end_x, int end_y, UUID attempting_user_id);
  85. void Subdivide(int start_x, int start_y, int end_x, int end_y, UUID attempting_user_id);
  86. }
  87. }