aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2014-01-17 23:36:23 +0000
committerJustin Clark-Casey (justincc)2014-01-17 23:36:23 +0000
commitb52b50ee56f3461d7f2dc47a905a0b10d07d3346 (patch)
treeb096fc343ca663500c32f67784561ecb4c6c8163 /OpenSim
parentminor: since structs are values, assigning them to another variable copies it... (diff)
downloadopensim-SC_OLD-b52b50ee56f3461d7f2dc47a905a0b10d07d3346.zip
opensim-SC_OLD-b52b50ee56f3461d7f2dc47a905a0b10d07d3346.tar.gz
opensim-SC_OLD-b52b50ee56f3461d7f2dc47a905a0b10d07d3346.tar.bz2
opensim-SC_OLD-b52b50ee56f3461d7f2dc47a905a0b10d07d3346.tar.xz
minor: reinsert some method doc back into IEntityTransferModule
Diffstat (limited to 'OpenSim')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs20
1 files changed, 20 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs b/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
index 1949a90..214b07a 100644
--- a/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
@@ -47,13 +47,33 @@ namespace OpenSim.Region.Framework.Interfaces
47 /// The handle of the destination region. If it's the same as the region currently 47 /// The handle of the destination region. If it's the same as the region currently
48 /// occupied by the agent then the teleport will be within that region. 48 /// occupied by the agent then the teleport will be within that region.
49 /// </param> 49 /// </param>
50 /// <param name='agent'></param>
51 /// <param name='regionHandle'></param>
50 /// <param name='position'></param> 52 /// <param name='position'></param>
51 /// <param name='lookAt'></param> 53 /// <param name='lookAt'></param>
52 /// <param name='teleportFlags'></param> 54 /// <param name='teleportFlags'></param>
53 void Teleport(ScenePresence agent, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags); 55 void Teleport(ScenePresence agent, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags);
54 56
57 /// <summary>
58 /// Teleports the agent for the given client to their home destination.
59 /// </summary>
60 /// <param name='id'></param>
61 /// <param name='client'></param>
55 bool TeleportHome(UUID id, IClientAPI client); 62 bool TeleportHome(UUID id, IClientAPI client);
56 63
64 /// <summary>
65 /// Teleport an agent directly to a given region without checking whether the region should be substituted.
66 /// </summary>
67 /// <remarks>
68 /// Please use Teleport() instead unless you know exactly what you're doing.
69 /// Do not use for same region teleports.
70 /// </remarks>
71 /// <param name='sp'></param>
72 /// <param name='reg'></param>
73 /// <param name='finalDestination'>/param>
74 /// <param name='position'></param>
75 /// <param name='lookAt'></param>
76 /// <param name='teleportFlags'></param>
57 void DoTeleport(ScenePresence sp, GridRegion reg, GridRegion finalDestination, 77 void DoTeleport(ScenePresence sp, GridRegion reg, GridRegion finalDestination,
58 Vector3 position, Vector3 lookAt, uint teleportFlags); 78 Vector3 position, Vector3 lookAt, uint teleportFlags);
59 79