aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework
diff options
context:
space:
mode:
authorTeravus Ovares (Dan Olivares)2009-08-14 21:37:25 -0400
committerTeravus Ovares (Dan Olivares)2009-08-14 21:37:25 -0400
commitf208628667aed5d1d98d17b5dda815ae5ed9bcc9 (patch)
tree23a336611f19bcf89626ce1083e47aaa0ff60563 /OpenSim/Region/Framework
parent* minor : comments (diff)
downloadopensim-SC_OLD-f208628667aed5d1d98d17b5dda815ae5ed9bcc9.zip
opensim-SC_OLD-f208628667aed5d1d98d17b5dda815ae5ed9bcc9.tar.gz
opensim-SC_OLD-f208628667aed5d1d98d17b5dda815ae5ed9bcc9.tar.bz2
opensim-SC_OLD-f208628667aed5d1d98d17b5dda815ae5ed9bcc9.tar.xz
* minor : Comments
* Also re-trigger Panda.
Diffstat (limited to 'OpenSim/Region/Framework')
-rw-r--r--OpenSim/Region/Framework/Scenes/Scene.cs71
1 files changed, 68 insertions, 3 deletions
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 919075c..56e5ef0 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -2170,6 +2170,14 @@ namespace OpenSim.Region.Framework.Scenes
2170 } 2170 }
2171 } 2171 }
2172 2172
2173 /// <summary>
2174 /// Sets the Home Point. The GridService uses this to know where to put a user when they log-in
2175 /// </summary>
2176 /// <param name="remoteClient"></param>
2177 /// <param name="regionHandle"></param>
2178 /// <param name="position"></param>
2179 /// <param name="lookAt"></param>
2180 /// <param name="flags"></param>
2173 public virtual void SetHomeRezPoint(IClientAPI remoteClient, ulong regionHandle, Vector3 position, Vector3 lookAt, uint flags) 2181 public virtual void SetHomeRezPoint(IClientAPI remoteClient, ulong regionHandle, Vector3 position, Vector3 lookAt, uint flags)
2174 { 2182 {
2175 UserProfileData UserProfile = CommsManager.UserService.GetUserProfile(remoteClient.AgentId); 2183 UserProfileData UserProfile = CommsManager.UserService.GetUserProfile(remoteClient.AgentId);
@@ -2340,6 +2348,12 @@ namespace OpenSim.Region.Framework.Scenes
2340 } 2348 }
2341 } 2349 }
2342 2350
2351 /// <summary>
2352 /// Removes region from an avatar's known region list. This coincides with child agents. For each child agent, there will be a known region entry.
2353 ///
2354 /// </summary>
2355 /// <param name="avatarID"></param>
2356 /// <param name="regionslst"></param>
2343 public void HandleRemoveKnownRegionsFromAvatar(UUID avatarID, List<ulong> regionslst) 2357 public void HandleRemoveKnownRegionsFromAvatar(UUID avatarID, List<ulong> regionslst)
2344 { 2358 {
2345 ScenePresence av = GetScenePresence(avatarID); 2359 ScenePresence av = GetScenePresence(avatarID);
@@ -2355,12 +2369,19 @@ namespace OpenSim.Region.Framework.Scenes
2355 } 2369 }
2356 } 2370 }
2357 2371
2372 /// <summary>
2373 /// Closes all endpoints with the circuitcode provided.
2374 /// </summary>
2375 /// <param name="circuitcode">Circuit Code of the endpoint to close</param>
2358 public override void CloseAllAgents(uint circuitcode) 2376 public override void CloseAllAgents(uint circuitcode)
2359 { 2377 {
2360 // Called by ClientView to kill all circuit codes 2378 // Called by ClientView to kill all circuit codes
2361 ClientManager.CloseAllAgents(circuitcode); 2379 ClientManager.CloseAllAgents(circuitcode);
2362 } 2380 }
2363 2381
2382 /// <summary>
2383 /// Inform all other ScenePresences on this Scene that someone else has changed position on the minimap.
2384 /// </summary>
2364 public void NotifyMyCoarseLocationChange() 2385 public void NotifyMyCoarseLocationChange()
2365 { 2386 {
2366 ForEachScenePresence(delegate(ScenePresence presence) { presence.CoarseLocationChange(); }); 2387 ForEachScenePresence(delegate(ScenePresence presence) { presence.CoarseLocationChange(); });
@@ -2455,9 +2476,10 @@ namespace OpenSim.Region.Framework.Scenes
2455 /// The return bool should allow for connections to be refused, but as not all calling paths 2476 /// The return bool should allow for connections to be refused, but as not all calling paths
2456 /// take proper notice of it let, we allowed banned users in still. 2477 /// take proper notice of it let, we allowed banned users in still.
2457 /// </summary> 2478 /// </summary>
2458 /// <param name="regionHandle"></param> 2479 /// <param name="agent">CircuitData of the agent who is connecting</param>
2459 /// <param name="agent"></param> 2480 /// <param name="reason">Outputs the reason for the false response on this string</param>
2460 /// <param name="reason"></param> 2481 /// <returns>True if the region accepts this agent. False if it does not. False will
2482 /// also return a reason.</returns>
2461 public bool NewUserConnection(AgentCircuitData agent, out string reason) 2483 public bool NewUserConnection(AgentCircuitData agent, out string reason)
2462 { 2484 {
2463 // Don't disable this log message - it's too helpful 2485 // Don't disable this log message - it's too helpful
@@ -2530,6 +2552,13 @@ namespace OpenSim.Region.Framework.Scenes
2530 return true; 2552 return true;
2531 } 2553 }
2532 2554
2555 /// <summary>
2556 /// Verifies that the user has a session on the Grid
2557 /// </summary>
2558 /// <param name="agent">Circuit Data of the Agent we're verifying</param>
2559 /// <param name="reason">Outputs the reason for the false response on this string</param>
2560 /// <returns>True if the user has a session on the grid. False if it does not. False will
2561 /// also return a reason.</returns>
2533 public virtual bool AuthenticateUser(AgentCircuitData agent, out string reason) 2562 public virtual bool AuthenticateUser(AgentCircuitData agent, out string reason)
2534 { 2563 {
2535 reason = String.Empty; 2564 reason = String.Empty;
@@ -2542,6 +2571,13 @@ namespace OpenSim.Region.Framework.Scenes
2542 return result; 2571 return result;
2543 } 2572 }
2544 2573
2574 /// <summary>
2575 /// Verify if the user can connect to this region. Checks the banlist and ensures that the region is set for public access
2576 /// </summary>
2577 /// <param name="agent">The circuit data for the agent</param>
2578 /// <param name="reason">outputs the reason to this string</param>
2579 /// <returns>True if the region accepts this agent. False if it does not. False will
2580 /// also return a reason.</returns>
2545 protected virtual bool AuthorizeUser(AgentCircuitData agent, out string reason) 2581 protected virtual bool AuthorizeUser(AgentCircuitData agent, out string reason)
2546 { 2582 {
2547 reason = String.Empty; 2583 reason = String.Empty;
@@ -2600,16 +2636,32 @@ namespace OpenSim.Region.Framework.Scenes
2600 return true; 2636 return true;
2601 } 2637 }
2602 2638
2639 /// <summary>
2640 /// Update an AgentCircuitData object with new information
2641 /// </summary>
2642 /// <param name="data">Information to update the AgentCircuitData with</param>
2603 public void UpdateCircuitData(AgentCircuitData data) 2643 public void UpdateCircuitData(AgentCircuitData data)
2604 { 2644 {
2605 m_authenticateHandler.UpdateAgentData(data); 2645 m_authenticateHandler.UpdateAgentData(data);
2606 } 2646 }
2607 2647
2648 /// <summary>
2649 /// Change the Circuit Code for the user's Circuit Data
2650 /// </summary>
2651 /// <param name="oldcc">The old Circuit Code. Must match a previous circuit code</param>
2652 /// <param name="newcc">The new Circuit Code. Must not be an already existing circuit code</param>
2653 /// <returns>True if we successfully changed it. False if we did not</returns>
2608 public bool ChangeCircuitCode(uint oldcc, uint newcc) 2654 public bool ChangeCircuitCode(uint oldcc, uint newcc)
2609 { 2655 {
2610 return m_authenticateHandler.TryChangeCiruitCode(oldcc, newcc); 2656 return m_authenticateHandler.TryChangeCiruitCode(oldcc, newcc);
2611 } 2657 }
2612 2658
2659 /// <summary>
2660 /// The Grid has requested that we log-off a user. Log them off.
2661 /// </summary>
2662 /// <param name="AvatarID">Unique ID of the avatar to log-off</param>
2663 /// <param name="RegionSecret">SecureSessionID of the user, or the RegionSecret text when logging on to the grid</param>
2664 /// <param name="message">message to display to the user. Reason for being logged off</param>
2613 public void HandleLogOffUserFromGrid(UUID AvatarID, UUID RegionSecret, string message) 2665 public void HandleLogOffUserFromGrid(UUID AvatarID, UUID RegionSecret, string message)
2614 { 2666 {
2615 ScenePresence loggingOffUser = null; 2667 ScenePresence loggingOffUser = null;
@@ -2675,6 +2727,13 @@ namespace OpenSim.Region.Framework.Scenes
2675 } 2727 }
2676 } 2728 }
2677 2729
2730 /// <summary>
2731 /// We've got an update about an agent that sees into this region,
2732 /// send it to ScenePresence for processing It's the full data.
2733 /// </summary>
2734 /// <param name="cAgentData">Agent that contains all of the relevant things about an agent.
2735 /// Appearance, animations, position, etc.</param>
2736 /// <returns>true if we handled it.</returns>
2678 public virtual bool IncomingChildAgentDataUpdate(AgentData cAgentData) 2737 public virtual bool IncomingChildAgentDataUpdate(AgentData cAgentData)
2679 { 2738 {
2680// m_log.DebugFormat( 2739// m_log.DebugFormat(
@@ -2692,6 +2751,12 @@ namespace OpenSim.Region.Framework.Scenes
2692 return false; 2751 return false;
2693 } 2752 }
2694 2753
2754 /// <summary>
2755 /// We've got an update about an agent that sees into this region,
2756 /// send it to ScenePresence for processing It's only positional data
2757 /// </summary>
2758 /// <param name="cAgentData">AgentPosition that contains agent positional data so we can know what to send</param>
2759 /// <returns>true if we handled it.</returns>
2695 public virtual bool IncomingChildAgentDataUpdate(AgentPosition cAgentData) 2760 public virtual bool IncomingChildAgentDataUpdate(AgentPosition cAgentData)
2696 { 2761 {
2697 //m_log.Debug(" XXX Scene IncomingChildAgentDataUpdate POSITION in " + RegionInfo.RegionName); 2762 //m_log.Debug(" XXX Scene IncomingChildAgentDataUpdate POSITION in " + RegionInfo.RegionName);