IEntityTransferModule.cs 5.5 KB

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