diff options
author | Justin Clark-Casey (justincc) | 2013-09-27 19:14:21 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2013-09-27 22:29:10 +0100 |
commit | e6c0267def09280761a6f2cbc668b2d0ad7f2753 (patch) | |
tree | 5ee0d4e25b3f5387e694c64325760d3221a2ad06 /OpenSim/Framework | |
parent | minor code formatting for the sake of consistency and readability (diff) | |
download | opensim-SC_OLD-e6c0267def09280761a6f2cbc668b2d0ad7f2753.zip opensim-SC_OLD-e6c0267def09280761a6f2cbc668b2d0ad7f2753.tar.gz opensim-SC_OLD-e6c0267def09280761a6f2cbc668b2d0ad7f2753.tar.bz2 opensim-SC_OLD-e6c0267def09280761a6f2cbc668b2d0ad7f2753.tar.xz |
refactor: rename Scene.IncomingCloseAgent() to CloseAgent() in order to make it clear that all non-clientstack callers should be using this rather than RemoveClient() in order to step through the ScenePresence state machine properly.
Adds IScene.CloseAgent() to replace RemoveClient()
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/IScene.cs | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/OpenSim/Framework/IScene.cs b/OpenSim/Framework/IScene.cs index 8164f41..c3df37b 100644 --- a/OpenSim/Framework/IScene.cs +++ b/OpenSim/Framework/IScene.cs | |||
@@ -86,7 +86,7 @@ namespace OpenSim.Framework | |||
86 | event restart OnRestart; | 86 | event restart OnRestart; |
87 | 87 | ||
88 | /// <summary> | 88 | /// <summary> |
89 | /// Add a new client and create a presence for it. All clients except initial login clients will starts off as a child agent | 89 | /// Add a new agent. All agents except initial login clients will starts off as a child agent |
90 | /// - the later agent crossing will promote it to a root agent. | 90 | /// - the later agent crossing will promote it to a root agent. |
91 | /// </summary> | 91 | /// </summary> |
92 | /// <param name="client"></param> | 92 | /// <param name="client"></param> |
@@ -96,14 +96,16 @@ namespace OpenSim.Framework | |||
96 | ISceneAgent AddNewClient(IClientAPI client, PresenceType type); | 96 | ISceneAgent AddNewClient(IClientAPI client, PresenceType type); |
97 | 97 | ||
98 | /// <summary> | 98 | /// <summary> |
99 | /// Remove the given client from the scene. | 99 | /// Tell a single agent to disconnect from the region. |
100 | /// </summary> | 100 | /// </summary> |
101 | /// <param name="agentID"></param> | 101 | /// <param name="agentID"></param> |
102 | /// <param name="closeChildAgents">Close the neighbour child agents associated with this client.</param> | 102 | /// <param name="force"> |
103 | void RemoveClient(UUID agentID, bool closeChildAgents); | 103 | /// Force the agent to close even if it might be in the middle of some other operation. You do not want to |
104 | /// force unless you are absolutely sure that the agent is dead and a normal close is not working. | ||
105 | /// </param> | ||
106 | bool CloseAgent(UUID agentID, bool force); | ||
104 | 107 | ||
105 | void Restart(); | 108 | void Restart(); |
106 | //RegionInfo OtherRegionUp(RegionInfo thisRegion); | ||
107 | 109 | ||
108 | string GetSimulatorVersion(); | 110 | string GetSimulatorVersion(); |
109 | 111 | ||