aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorSignpostMarv2012-09-21 23:32:41 +0100
committerJustin Clark-Casey (justincc)2012-09-22 00:57:29 +0100
commit8d7b1f8aa08efbb2d0087abee22178c36cbc2f98 (patch)
tree6c32c852c521f1aab13898f7db3e695e8db5b7a6
parentMerge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff)
downloadopensim-SC_OLD-8d7b1f8aa08efbb2d0087abee22178c36cbc2f98.zip
opensim-SC_OLD-8d7b1f8aa08efbb2d0087abee22178c36cbc2f98.tar.gz
opensim-SC_OLD-8d7b1f8aa08efbb2d0087abee22178c36cbc2f98.tar.bz2
opensim-SC_OLD-8d7b1f8aa08efbb2d0087abee22178c36cbc2f98.tar.xz
Documenting non-LSL script-related events
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs52
1 files changed, 52 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index f079e00..96e9797 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -279,6 +279,16 @@ namespace OpenSim.Region.Framework.Scenes
279 /// in <see cref="Scene.ProcessObjectDeGrab"/> 279 /// in <see cref="Scene.ProcessObjectDeGrab"/>
280 /// </remarks> 280 /// </remarks>
281 public event ObjectDeGrabDelegate OnObjectDeGrab; 281 public event ObjectDeGrabDelegate OnObjectDeGrab;
282
283 /// <summary>
284 /// Triggered when a script resets.
285 /// </summary>
286 /// <remarks>
287 /// Triggered by <see cref="TriggerScriptReset"/>
288 /// in <see cref="Scene.ProcessScriptReset"/>
289 /// via <see cref="OpenSim.Framework.IClientAPI.OnScriptReset"/>
290 /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.LLClientView.HandleScriptReset"/>
291 /// </remarks>
282 public event ScriptResetDelegate OnScriptReset; 292 public event ScriptResetDelegate OnScriptReset;
283 293
284 public event OnPermissionErrorDelegate OnPermissionError; 294 public event OnPermissionErrorDelegate OnPermissionError;
@@ -288,17 +298,50 @@ namespace OpenSim.Region.Framework.Scenes
288 /// </summary> 298 /// </summary>
289 /// <remarks> 299 /// <remarks>
290 /// Occurs after OnNewScript. 300 /// Occurs after OnNewScript.
301 /// Triggered by <see cref="TriggerRezScript"/>
302 /// in <see cref="SceneObjectPartInventory.CreateScriptInstance"/>
291 /// </remarks> 303 /// </remarks>
292 public event NewRezScript OnRezScript; 304 public event NewRezScript OnRezScript;
293 public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource); 305 public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource);
294 306
295 public delegate void RemoveScript(uint localID, UUID itemID); 307 public delegate void RemoveScript(uint localID, UUID itemID);
308
309 /// <summary>
310 /// Triggered when a script is removed from an object.
311 /// </summary>
312 /// <remarks>
313 /// Triggered by <see cref="TriggerRemoveScript"/>
314 /// in <see cref="Scene.RemoveTaskInventory"/>,
315 /// <see cref="Scene.CreateAgentInventoryItemFromTask"/>,
316 /// <see cref="SceneObjectPartInventory.RemoveScriptInstance"/>,
317 /// <see cref="SceneObjectPartInventory.RemoveInventoryItem"/>
318 /// </remarks>
296 public event RemoveScript OnRemoveScript; 319 public event RemoveScript OnRemoveScript;
297 320
298 public delegate void StartScript(uint localID, UUID itemID); 321 public delegate void StartScript(uint localID, UUID itemID);
322
323 /// <summary>
324 /// Triggered when a script starts.
325 /// </summary>
326 /// <remarks>
327 /// Triggered by <see cref="TriggerStartScript"/>
328 /// in <see cref="Scene.SetScriptRunning"/>
329 /// via <see cref="OpenSim.Framework.IClientAPI.OnSetScriptRunning"/>,
330 /// via <see cref="OpenSim.Region.ClientStack.LindenUDP.HandleSetScriptRunning"/>
331 /// </remarks>
299 public event StartScript OnStartScript; 332 public event StartScript OnStartScript;
300 333
301 public delegate void StopScript(uint localID, UUID itemID); 334 public delegate void StopScript(uint localID, UUID itemID);
335
336 /// <summary>
337 /// Triggered when a script stops.
338 /// </summary>
339 /// <remarks>
340 /// Triggered by <see cref="TriggerStopScript"/>,
341 /// in <see cref="SceneObjectPartInventory.CreateScriptInstance"/>,
342 /// <see cref="SceneObjectPartInventory.StopScriptInstance"/>,
343 /// <see cref="Scene.SetScriptRunning"/>
344 /// </remarks>
302 public event StopScript OnStopScript; 345 public event StopScript OnStopScript;
303 346
304 public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta); 347 public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta);
@@ -349,6 +392,9 @@ namespace OpenSim.Region.Framework.Scenes
349 /// </summary> 392 /// </summary>
350 /// <remarks> 393 /// <remarks>
351 /// Occurs before OnRezScript 394 /// Occurs before OnRezScript
395 /// Triggered by <see cref="TriggerNewScript"/>
396 /// in <see cref="Scene.RezScriptFromAgentInventory"/>,
397 /// <see cref="Scene.RezNewScript"/>
352 /// </remarks> 398 /// </remarks>
353 public event NewScript OnNewScript; 399 public event NewScript OnNewScript;
354 400
@@ -383,6 +429,12 @@ namespace OpenSim.Region.Framework.Scenes
383 /// </summary> 429 /// </summary>
384 /// <remarks> 430 /// <remarks>
385 /// Triggered after the scene receives a client's upload of an updated script and has stored it in an asset. 431 /// Triggered after the scene receives a client's upload of an updated script and has stored it in an asset.
432 /// Triggered by <see cref="TriggerUpdateScript"/>
433 /// in <see cref="Scene.CapsUpdateTaskInventoryScriptAsset"/>
434 /// via <see cref="Scene.CapsUpdateTaskInventoryScriptAsset"/>
435 /// via <see cref="OpenSim.Region.ClientStack.Linden.BunchOfCaps.TaskScriptUpdated"/>
436 /// via <see cref="OpenSim.Region.ClientStack.Linden.TaskInventoryScriptUpdater.OnUpLoad"/>
437 /// via <see cref="OpenSim.Region.ClientStack.Linden.TaskInventoryScriptUpdater.uploaderCaps"/>
386 /// </remarks> 438 /// </remarks>
387 public event UpdateScript OnUpdateScript; 439 public event UpdateScript OnUpdateScript;
388 440