From f208628667aed5d1d98d17b5dda815ae5ed9bcc9 Mon Sep 17 00:00:00 2001 From: "Teravus Ovares (Dan Olivares)" Date: Fri, 14 Aug 2009 21:37:25 -0400 Subject: [PATCH] * minor : Comments * Also re-trigger Panda. --- OpenSim/Region/Framework/Scenes/Scene.cs | 71 +++++++++++++++++++++++- 1 file changed, 68 insertions(+), 3 deletions(-) diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs index 919075c1bd..56e5ef0994 100644 --- a/OpenSim/Region/Framework/Scenes/Scene.cs +++ b/OpenSim/Region/Framework/Scenes/Scene.cs @@ -2170,6 +2170,14 @@ namespace OpenSim.Region.Framework.Scenes } } + /// + /// Sets the Home Point. The GridService uses this to know where to put a user when they log-in + /// + /// + /// + /// + /// + /// public virtual void SetHomeRezPoint(IClientAPI remoteClient, ulong regionHandle, Vector3 position, Vector3 lookAt, uint flags) { UserProfileData UserProfile = CommsManager.UserService.GetUserProfile(remoteClient.AgentId); @@ -2340,6 +2348,12 @@ namespace OpenSim.Region.Framework.Scenes } } + /// + /// 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. + /// + /// + /// + /// public void HandleRemoveKnownRegionsFromAvatar(UUID avatarID, List regionslst) { ScenePresence av = GetScenePresence(avatarID); @@ -2355,12 +2369,19 @@ namespace OpenSim.Region.Framework.Scenes } } + /// + /// Closes all endpoints with the circuitcode provided. + /// + /// Circuit Code of the endpoint to close public override void CloseAllAgents(uint circuitcode) { // Called by ClientView to kill all circuit codes ClientManager.CloseAllAgents(circuitcode); } + /// + /// Inform all other ScenePresences on this Scene that someone else has changed position on the minimap. + /// public void NotifyMyCoarseLocationChange() { ForEachScenePresence(delegate(ScenePresence presence) { presence.CoarseLocationChange(); }); @@ -2455,9 +2476,10 @@ namespace OpenSim.Region.Framework.Scenes /// The return bool should allow for connections to be refused, but as not all calling paths /// take proper notice of it let, we allowed banned users in still. /// - /// - /// - /// + /// CircuitData of the agent who is connecting + /// Outputs the reason for the false response on this string + /// True if the region accepts this agent. False if it does not. False will + /// also return a reason. public bool NewUserConnection(AgentCircuitData agent, out string reason) { // Don't disable this log message - it's too helpful @@ -2530,6 +2552,13 @@ namespace OpenSim.Region.Framework.Scenes return true; } + /// + /// Verifies that the user has a session on the Grid + /// + /// Circuit Data of the Agent we're verifying + /// Outputs the reason for the false response on this string + /// True if the user has a session on the grid. False if it does not. False will + /// also return a reason. public virtual bool AuthenticateUser(AgentCircuitData agent, out string reason) { reason = String.Empty; @@ -2542,6 +2571,13 @@ namespace OpenSim.Region.Framework.Scenes return result; } + /// + /// Verify if the user can connect to this region. Checks the banlist and ensures that the region is set for public access + /// + /// The circuit data for the agent + /// outputs the reason to this string + /// True if the region accepts this agent. False if it does not. False will + /// also return a reason. protected virtual bool AuthorizeUser(AgentCircuitData agent, out string reason) { reason = String.Empty; @@ -2600,16 +2636,32 @@ namespace OpenSim.Region.Framework.Scenes return true; } + /// + /// Update an AgentCircuitData object with new information + /// + /// Information to update the AgentCircuitData with public void UpdateCircuitData(AgentCircuitData data) { m_authenticateHandler.UpdateAgentData(data); } + /// + /// Change the Circuit Code for the user's Circuit Data + /// + /// The old Circuit Code. Must match a previous circuit code + /// The new Circuit Code. Must not be an already existing circuit code + /// True if we successfully changed it. False if we did not public bool ChangeCircuitCode(uint oldcc, uint newcc) { return m_authenticateHandler.TryChangeCiruitCode(oldcc, newcc); } + /// + /// The Grid has requested that we log-off a user. Log them off. + /// + /// Unique ID of the avatar to log-off + /// SecureSessionID of the user, or the RegionSecret text when logging on to the grid + /// message to display to the user. Reason for being logged off public void HandleLogOffUserFromGrid(UUID AvatarID, UUID RegionSecret, string message) { ScenePresence loggingOffUser = null; @@ -2675,6 +2727,13 @@ namespace OpenSim.Region.Framework.Scenes } } + /// + /// We've got an update about an agent that sees into this region, + /// send it to ScenePresence for processing It's the full data. + /// + /// Agent that contains all of the relevant things about an agent. + /// Appearance, animations, position, etc. + /// true if we handled it. public virtual bool IncomingChildAgentDataUpdate(AgentData cAgentData) { // m_log.DebugFormat( @@ -2692,6 +2751,12 @@ namespace OpenSim.Region.Framework.Scenes return false; } + /// + /// We've got an update about an agent that sees into this region, + /// send it to ScenePresence for processing It's only positional data + /// + /// AgentPosition that contains agent positional data so we can know what to send + /// true if we handled it. public virtual bool IncomingChildAgentDataUpdate(AgentPosition cAgentData) { //m_log.Debug(" XXX Scene IncomingChildAgentDataUpdate POSITION in " + RegionInfo.RegionName);