aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2012-10-09 22:19:47 +0100
committerJustin Clark-Casey (justincc)2012-10-09 22:19:47 +0100
commita3c0e3ed260a8a76e3009e99162cdcb8142ea1b1 (patch)
tree354f10380ed07a2db62ae5e5ccee5e35478bce1d /OpenSim
parentMerge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff)
downloadopensim-SC_OLD-a3c0e3ed260a8a76e3009e99162cdcb8142ea1b1.zip
opensim-SC_OLD-a3c0e3ed260a8a76e3009e99162cdcb8142ea1b1.tar.gz
opensim-SC_OLD-a3c0e3ed260a8a76e3009e99162cdcb8142ea1b1.tar.bz2
opensim-SC_OLD-a3c0e3ed260a8a76e3009e99162cdcb8142ea1b1.tar.xz
minor: elaborate method doc on Scene.NewUserConnection()
Diffstat (limited to 'OpenSim')
-rw-r--r--OpenSim/Region/Framework/Scenes/Scene.cs19
1 files changed, 13 insertions, 6 deletions
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 671feda..ed88571 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -3461,11 +3461,9 @@ namespace OpenSim.Region.Framework.Scenes
3461 3461
3462 /// <summary> 3462 /// <summary>
3463 /// Do the work necessary to initiate a new user connection for a particular scene. 3463 /// Do the work necessary to initiate a new user connection for a particular scene.
3464 /// At the moment, this consists of setting up the caps infrastructure
3465 /// The return bool should allow for connections to be refused, but as not all calling paths
3466 /// take proper notice of it let, we allowed banned users in still.
3467 /// </summary> 3464 /// </summary>
3468 /// <param name="agent">CircuitData of the agent who is connecting</param> 3465 /// <param name="agent">CircuitData of the agent who is connecting</param>
3466 /// <param name="teleportFlags"></param>
3469 /// <param name="reason">Outputs the reason for the false response on this string</param> 3467 /// <param name="reason">Outputs the reason for the false response on this string</param>
3470 /// <returns>True if the region accepts this agent. False if it does not. False will 3468 /// <returns>True if the region accepts this agent. False if it does not. False will
3471 /// also return a reason.</returns> 3469 /// also return a reason.</returns>
@@ -3476,10 +3474,20 @@ namespace OpenSim.Region.Framework.Scenes
3476 3474
3477 /// <summary> 3475 /// <summary>
3478 /// Do the work necessary to initiate a new user connection for a particular scene. 3476 /// Do the work necessary to initiate a new user connection for a particular scene.
3479 /// At the moment, this consists of setting up the caps infrastructure 3477 /// </summary>
3478 /// <remarks>
3479 /// The return bool should allow for connections to be refused, but as not all calling paths
3480 /// take proper notice of it yet, we still allowed banned users in.
3481 ///
3482 /// At the moment this method consists of setting up the caps infrastructure
3480 /// The return bool should allow for connections to be refused, but as not all calling paths 3483 /// The return bool should allow for connections to be refused, but as not all calling paths
3481 /// take proper notice of it let, we allowed banned users in still. 3484 /// take proper notice of it let, we allowed banned users in still.
3482 /// </summary> 3485 ///
3486 /// This method is called by the login service (in the case of login) or another simulator (in the case of region
3487 /// cross or teleport) to initiate the connection. It is not triggered by the viewer itself - the connection
3488 /// is activated later when the viewer sends the initial UseCircuitCodePacket UDP packet (in the case of
3489 /// the LLUDP stack).
3490 /// </remarks>
3483 /// <param name="agent">CircuitData of the agent who is connecting</param> 3491 /// <param name="agent">CircuitData of the agent who is connecting</param>
3484 /// <param name="reason">Outputs the reason for the false response on this string</param> 3492 /// <param name="reason">Outputs the reason for the false response on this string</param>
3485 /// <param name="requirePresenceLookup">True for normal presence. False for NPC 3493 /// <param name="requirePresenceLookup">True for normal presence. False for NPC
@@ -3566,7 +3574,6 @@ namespace OpenSim.Region.Framework.Scenes
3566 return false; 3574 return false;
3567 } 3575 }
3568 3576
3569
3570 ScenePresence sp = GetScenePresence(agent.AgentID); 3577 ScenePresence sp = GetScenePresence(agent.AgentID);
3571 3578
3572 if (sp != null && !sp.IsChildAgent) 3579 if (sp != null && !sp.IsChildAgent)