From cb2e4952022d61c121a05030743ea4302373547a Mon Sep 17 00:00:00 2001 From: Adam Frisby Date: Sun, 22 Apr 2007 03:25:18 +0000 Subject: Commented first 50% of World.cs's functions with /// tags --- OpenSim.RegionServer/world/World.cs | 64 +++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) 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 private InventoryCache _inventoryCache; private AssetCache _assetCache; + /// + /// Creates a new World class, and a region to go with it. + /// + /// Dictionary to contain client threads + /// Region Handle for this region + /// Region Name for this region public World(Dictionary clientThreads, ulong regionHandle, string regionName) { try @@ -76,6 +82,11 @@ namespace OpenSim.world } } + /// + /// Loads a new script into the specified entity + /// + /// Entity to be scripted + /// The script to load public void AddScript(Entity entity, Script script) { try @@ -89,6 +100,11 @@ namespace OpenSim.world } } + /// + /// Loads a new script into the specified entity, using a script loaded from a string. + /// + /// The entity to be scripted + /// The string containing the script public void AddScript(Entity entity, string scriptData) { try @@ -163,6 +179,9 @@ namespace OpenSim.world } } + /// + /// Performs per-frame updates on the world, this should be the central world loop + /// public void Update() { try @@ -210,6 +229,11 @@ namespace OpenSim.world } } + /// + /// Loads a new storage subsystem from a named library + /// + /// Storage Library + /// Successful or not public bool LoadStorageDLL(string dllName) { try @@ -249,6 +273,9 @@ namespace OpenSim.world #region Regenerate Terrain + /// + /// Rebuilds the terrain using a procedural algorithm + /// public void RegenerateTerrain() { try @@ -277,6 +304,10 @@ namespace OpenSim.world } } + /// + /// Rebuilds the terrain using a 2D float array + /// + /// 256,256 float array containing heights public void RegenerateTerrain(float[,] newMap) { try @@ -304,6 +335,12 @@ namespace OpenSim.world } } + /// + /// Rebuilds the terrain assuming changes occured at a specified point[?] + /// + /// ??? + /// ??? + /// ??? public void RegenerateTerrain(bool changes, int pointx, int pointy) { try @@ -330,6 +367,9 @@ namespace OpenSim.world #endregion + /// + /// Loads the World heightmap + /// public void LoadWorldMap() { try @@ -353,6 +393,9 @@ namespace OpenSim.world } } + /// + /// Loads the World's objects + /// public void LoadPrimsFromStorage() { try @@ -366,6 +409,10 @@ namespace OpenSim.world } } + /// + /// Loads a specific object from storage + /// + /// The object to load public void PrimFromStorage(PrimData prim) { try @@ -385,6 +432,9 @@ namespace OpenSim.world } } + /// + /// Tidy before shutdown + /// public void Close() { try @@ -397,6 +447,10 @@ namespace OpenSim.world } } + /// + /// Send the region heightmap to the client + /// + /// Client to send to public void SendLayerData(SimClient RemoteClient) { try @@ -423,6 +477,12 @@ namespace OpenSim.world } } + /// + /// Sends a specified patch to a client + /// + /// Patch coordinate (x) 0..16 + /// Patch coordinate (y) 0..16 + /// The client to send to public void SendLayerData(int px, int py, SimClient RemoteClient) { try @@ -450,6 +510,10 @@ namespace OpenSim.world } } + /// + /// Sends prims to a client + /// + /// Client to send to public void GetInitialPrims(SimClient RemoteClient) { try -- cgit v1.1