Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Documenting non-LSL script-related events

  • Loading branch information...
commit 8d7b1f8aa08efbb2d0087abee22178c36cbc2f98 1 parent 9ab5c50
SignpostMarv authored September 21, 2012 justincc committed September 22, 2012
52  OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -279,6 +279,16 @@ public class EventManager
279 279
         /// in <see cref="Scene.ProcessObjectDeGrab"/>
280 280
         /// </remarks>
281 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 292
         public event ScriptResetDelegate OnScriptReset;
283 293
 
284 294
         public event OnPermissionErrorDelegate OnPermissionError;
@@ -288,17 +298,50 @@ public class EventManager
288 298
         /// </summary>
289 299
         /// <remarks>
290 300
         /// Occurs after OnNewScript.
  301
+        /// Triggered by <see cref="TriggerRezScript"/>
  302
+        /// in <see cref="SceneObjectPartInventory.CreateScriptInstance"/>
291 303
         /// </remarks>
292 304
         public event NewRezScript OnRezScript;
293 305
         public delegate void NewRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource);
294 306
 
295 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 319
         public event RemoveScript OnRemoveScript;
297 320
 
298 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 332
         public event StartScript OnStartScript;
300 333
 
301 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 345
         public event StopScript OnStopScript;
303 346
 
304 347
         public delegate bool SceneGroupMoved(UUID groupID, Vector3 delta);
@@ -349,6 +392,9 @@ public class EventManager
349 392
         /// </summary>
350 393
         /// <remarks>
351 394
         /// Occurs before OnRezScript
  395
+        /// Triggered by <see cref="TriggerNewScript"/>
  396
+        /// in <see cref="Scene.RezScriptFromAgentInventory"/>,
  397
+        /// <see cref="Scene.RezNewScript"/>
352 398
         /// </remarks>
353 399
         public event NewScript OnNewScript;
354 400
 
@@ -383,6 +429,12 @@ public virtual void TriggerNewScript(UUID clientID, SceneObjectPart part, UUID i
383 429
         /// </summary>
384 430
         /// <remarks>
385 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 438
         /// </remarks>
387 439
         public event UpdateScript OnUpdateScript;
388 440
         

0 notes on commit 8d7b1f8

Please sign in to comment.
Something went wrong with that request. Please try again.