IEntityTransferModule.cs 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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;
  28. using OpenSim.Services.Interfaces;
  29. using GridRegion = OpenSim.Services.Interfaces.GridRegion;
  30. using OpenMetaverse;
  31. using OpenSim.Framework;
  32. using OpenSim.Region.Framework.Scenes;
  33. namespace OpenSim.Region.Framework.Interfaces
  34. {
  35. public delegate ScenePresence CrossAgentToNewRegionDelegate(ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, string version);
  36. public interface IEntityTransferModule
  37. {
  38. /// <summary>
  39. /// Teleport an agent within the same or to a different region.
  40. /// </summary>
  41. /// <param name='agent'></param>
  42. /// <param name='regionHandle'>
  43. /// The handle of the destination region. If it's the same as the region currently
  44. /// occupied by the agent then the teleport will be within that region.
  45. /// </param>
  46. /// <param name='agent'></param>
  47. /// <param name='regionHandle'></param>
  48. /// <param name='position'></param>
  49. /// <param name='lookAt'></param>
  50. /// <param name='teleportFlags'></param>
  51. void Teleport(ScenePresence agent, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags);
  52. /// <summary>
  53. /// Teleports the agent for the given client to their home destination.
  54. /// </summary>
  55. /// <param name='id'></param>
  56. /// <param name='client'></param>
  57. bool TeleportHome(UUID id, IClientAPI client);
  58. /// <summary>
  59. /// Teleport an agent directly to a given region without checking whether the region should be substituted.
  60. /// </summary>
  61. /// <remarks>
  62. /// Please use Teleport() instead unless you know exactly what you're doing.
  63. /// Do not use for same region teleports.
  64. /// </remarks>
  65. /// <param name='sp'></param>
  66. /// <param name='reg'></param>
  67. /// <param name='finalDestination'>/param>
  68. /// <param name='position'></param>
  69. /// <param name='lookAt'></param>
  70. /// <param name='teleportFlags'></param>
  71. void DoTeleport(ScenePresence sp, GridRegion reg, GridRegion finalDestination,
  72. Vector3 position, Vector3 lookAt, uint teleportFlags);
  73. /// <summary>
  74. /// Show whether the given agent is being teleported.
  75. /// </summary>
  76. /// <param name='id'>The agent ID</para></param>
  77. /// <returns>true if the agent is in the process of being teleported, false otherwise.</returns>
  78. bool IsInTransit(UUID id);
  79. bool Cross(ScenePresence agent, bool isFlying);
  80. void AgentArrivedAtDestination(UUID agent);
  81. void EnableChildAgents(ScenePresence agent);
  82. void EnableChildAgent(ScenePresence agent, GridRegion region);
  83. GridRegion GetDestination(Scene scene, UUID agentID, Vector3 pos, out string version,
  84. out Vector3 newpos, out string reason);
  85. void Cross(SceneObjectGroup sog, Vector3 position, bool silent);
  86. ScenePresence CrossAgentToNewRegionAsync(ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, string version);
  87. }
  88. public interface IUserAgentVerificationModule
  89. {
  90. bool VerifyClient(AgentCircuitData aCircuit, string token);
  91. }
  92. }