aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorAdam Frisby2007-04-22 03:25:18 +0000
committerAdam Frisby2007-04-22 03:25:18 +0000
commitcb2e4952022d61c121a05030743ea4302373547a (patch)
treeaf97931b0d7ce933ddccfa1c50ce9eb8a0ff61d5
parentSmall fix (diff)
downloadopensim-SC_OLD-cb2e4952022d61c121a05030743ea4302373547a.zip
opensim-SC_OLD-cb2e4952022d61c121a05030743ea4302373547a.tar.gz
opensim-SC_OLD-cb2e4952022d61c121a05030743ea4302373547a.tar.bz2
opensim-SC_OLD-cb2e4952022d61c121a05030743ea4302373547a.tar.xz
Commented first 50% of World.cs's functions with /// tags
-rw-r--r--OpenSim.RegionServer/world/World.cs64
1 files changed, 64 insertions, 0 deletions
diff --git a/OpenSim.RegionServer/world/World.cs b/OpenSim.RegionServer/world/World.cs
index ead429f..a3f2b5e 100644
--- a/OpenSim.RegionServer/world/World.cs
+++ b/OpenSim.RegionServer/world/World.cs
@@ -43,6 +43,12 @@ namespace OpenSim.world
43 private InventoryCache _inventoryCache; 43 private InventoryCache _inventoryCache;
44 private AssetCache _assetCache; 44 private AssetCache _assetCache;
45 45
46 /// <summary>
47 /// Creates a new World class, and a region to go with it.
48 /// </summary>
49 /// <param name="clientThreads">Dictionary to contain client threads</param>
50 /// <param name="regionHandle">Region Handle for this region</param>
51 /// <param name="regionName">Region Name for this region</param>
46 public World(Dictionary<uint, SimClient> clientThreads, ulong regionHandle, string regionName) 52 public World(Dictionary<uint, SimClient> clientThreads, ulong regionHandle, string regionName)
47 { 53 {
48 try 54 try
@@ -76,6 +82,11 @@ namespace OpenSim.world
76 } 82 }
77 } 83 }
78 84
85 /// <summary>
86 /// Loads a new script into the specified entity
87 /// </summary>
88 /// <param name="entity">Entity to be scripted</param>
89 /// <param name="script">The script to load</param>
79 public void AddScript(Entity entity, Script script) 90 public void AddScript(Entity entity, Script script)
80 { 91 {
81 try 92 try
@@ -89,6 +100,11 @@ namespace OpenSim.world
89 } 100 }
90 } 101 }
91 102
103 /// <summary>
104 /// Loads a new script into the specified entity, using a script loaded from a string.
105 /// </summary>
106 /// <param name="entity">The entity to be scripted</param>
107 /// <param name="scriptData">The string containing the script</param>
92 public void AddScript(Entity entity, string scriptData) 108 public void AddScript(Entity entity, string scriptData)
93 { 109 {
94 try 110 try
@@ -163,6 +179,9 @@ namespace OpenSim.world
163 } 179 }
164 } 180 }
165 181
182 /// <summary>
183 /// Performs per-frame updates on the world, this should be the central world loop
184 /// </summary>
166 public void Update() 185 public void Update()
167 { 186 {
168 try 187 try
@@ -210,6 +229,11 @@ namespace OpenSim.world
210 } 229 }
211 } 230 }
212 231
232 /// <summary>
233 /// Loads a new storage subsystem from a named library
234 /// </summary>
235 /// <param name="dllName">Storage Library</param>
236 /// <returns>Successful or not</returns>
213 public bool LoadStorageDLL(string dllName) 237 public bool LoadStorageDLL(string dllName)
214 { 238 {
215 try 239 try
@@ -249,6 +273,9 @@ namespace OpenSim.world
249 273
250 #region Regenerate Terrain 274 #region Regenerate Terrain
251 275
276 /// <summary>
277 /// Rebuilds the terrain using a procedural algorithm
278 /// </summary>
252 public void RegenerateTerrain() 279 public void RegenerateTerrain()
253 { 280 {
254 try 281 try
@@ -277,6 +304,10 @@ namespace OpenSim.world
277 } 304 }
278 } 305 }
279 306
307 /// <summary>
308 /// Rebuilds the terrain using a 2D float array
309 /// </summary>
310 /// <param name="newMap">256,256 float array containing heights</param>
280 public void RegenerateTerrain(float[,] newMap) 311 public void RegenerateTerrain(float[,] newMap)
281 { 312 {
282 try 313 try
@@ -304,6 +335,12 @@ namespace OpenSim.world
304 } 335 }
305 } 336 }
306 337
338 /// <summary>
339 /// Rebuilds the terrain assuming changes occured at a specified point[?]
340 /// </summary>
341 /// <param name="changes">???</param>
342 /// <param name="pointx">???</param>
343 /// <param name="pointy">???</param>
307 public void RegenerateTerrain(bool changes, int pointx, int pointy) 344 public void RegenerateTerrain(bool changes, int pointx, int pointy)
308 { 345 {
309 try 346 try
@@ -330,6 +367,9 @@ namespace OpenSim.world
330 367
331 #endregion 368 #endregion
332 369
370 /// <summary>
371 /// Loads the World heightmap
372 /// </summary>
333 public void LoadWorldMap() 373 public void LoadWorldMap()
334 { 374 {
335 try 375 try
@@ -353,6 +393,9 @@ namespace OpenSim.world
353 } 393 }
354 } 394 }
355 395
396 /// <summary>
397 /// Loads the World's objects
398 /// </summary>
356 public void LoadPrimsFromStorage() 399 public void LoadPrimsFromStorage()
357 { 400 {
358 try 401 try
@@ -366,6 +409,10 @@ namespace OpenSim.world
366 } 409 }
367 } 410 }
368 411
412 /// <summary>
413 /// Loads a specific object from storage
414 /// </summary>
415 /// <param name="prim">The object to load</param>
369 public void PrimFromStorage(PrimData prim) 416 public void PrimFromStorage(PrimData prim)
370 { 417 {
371 try 418 try
@@ -385,6 +432,9 @@ namespace OpenSim.world
385 } 432 }
386 } 433 }
387 434
435 /// <summary>
436 /// Tidy before shutdown
437 /// </summary>
388 public void Close() 438 public void Close()
389 { 439 {
390 try 440 try
@@ -397,6 +447,10 @@ namespace OpenSim.world
397 } 447 }
398 } 448 }
399 449
450 /// <summary>
451 /// Send the region heightmap to the client
452 /// </summary>
453 /// <param name="RemoteClient">Client to send to</param>
400 public void SendLayerData(SimClient RemoteClient) 454 public void SendLayerData(SimClient RemoteClient)
401 { 455 {
402 try 456 try
@@ -423,6 +477,12 @@ namespace OpenSim.world
423 } 477 }
424 } 478 }
425 479
480 /// <summary>
481 /// Sends a specified patch to a client
482 /// </summary>
483 /// <param name="px">Patch coordinate (x) 0..16</param>
484 /// <param name="py">Patch coordinate (y) 0..16</param>
485 /// <param name="RemoteClient">The client to send to</param>
426 public void SendLayerData(int px, int py, SimClient RemoteClient) 486 public void SendLayerData(int px, int py, SimClient RemoteClient)
427 { 487 {
428 try 488 try
@@ -450,6 +510,10 @@ namespace OpenSim.world
450 } 510 }
451 } 511 }
452 512
513 /// <summary>
514 /// Sends prims to a client
515 /// </summary>
516 /// <param name="RemoteClient">Client to send to</param>
453 public void GetInitialPrims(SimClient RemoteClient) 517 public void GetInitialPrims(SimClient RemoteClient)
454 { 518 {
455 try 519 try