aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim.RegionServer
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim.RegionServer')
-rw-r--r--OpenSim.RegionServer/OpenSimMain.cs20
-rw-r--r--OpenSim.RegionServer/world/Entity.cs12
2 files changed, 31 insertions, 1 deletions
diff --git a/OpenSim.RegionServer/OpenSimMain.cs b/OpenSim.RegionServer/OpenSimMain.cs
index fa5dfc2..f4eea11 100644
--- a/OpenSim.RegionServer/OpenSimMain.cs
+++ b/OpenSim.RegionServer/OpenSimMain.cs
@@ -96,6 +96,9 @@ namespace OpenSim
96 OpenSim.Framework.Console.MainConsole.Instance = m_console; 96 OpenSim.Framework.Console.MainConsole.Instance = m_console;
97 } 97 }
98 98
99 /// <summary>
100 /// Performs initialisation of the world, such as loading configuration from disk.
101 /// </summary>
99 public virtual void StartUp() 102 public virtual void StartUp()
100 { 103 {
101 this.regionData = new RegionInfo(); 104 this.regionData = new RegionInfo();
@@ -358,6 +361,9 @@ namespace OpenSim
358 } 361 }
359 } 362 }
360 363
364 /// <summary>
365 /// Performs any last-minute sanity checking and shuts down the region server
366 /// </summary>
361 public virtual void Shutdown() 367 public virtual void Shutdown()
362 { 368 {
363 m_console.WriteLine("Main.cs:Shutdown() - Closing all threads"); 369 m_console.WriteLine("Main.cs:Shutdown() - Closing all threads");
@@ -371,11 +377,21 @@ namespace OpenSim
371 Environment.Exit(0); 377 Environment.Exit(0);
372 } 378 }
373 379
380 /// <summary>
381 /// Performs per-frame updates regularly
382 /// </summary>
383 /// <param name="sender"></param>
384 /// <param name="e"></param>
374 void Heartbeat(object sender, System.EventArgs e) 385 void Heartbeat(object sender, System.EventArgs e)
375 { 386 {
376 LocalWorld.Update(); 387 LocalWorld.Update();
377 } 388 }
378 389
390 /// <summary>
391 /// Runs commands issued by the server console from the operator
392 /// </summary>
393 /// <param name="command">The first argument of the parameter (the command)</param>
394 /// <param name="cmdparams">Additional arguments passed to the command</param>
379 public void RunCmd(string command, string[] cmdparams) 395 public void RunCmd(string command, string[] cmdparams)
380 { 396 {
381 switch (command) 397 switch (command)
@@ -400,6 +416,10 @@ namespace OpenSim
400 } 416 }
401 } 417 }
402 418
419 /// <summary>
420 /// Outputs to the console information about the region
421 /// </summary>
422 /// <param name="ShowWhat">What information to display (valid arguments are "uptime", "users")</param>
403 public void Show(string ShowWhat) 423 public void Show(string ShowWhat)
404 { 424 {
405 switch (ShowWhat) 425 switch (ShowWhat)
diff --git a/OpenSim.RegionServer/world/Entity.cs b/OpenSim.RegionServer/world/Entity.cs
index b59d200..96e039a 100644
--- a/OpenSim.RegionServer/world/Entity.cs
+++ b/OpenSim.RegionServer/world/Entity.cs
@@ -62,7 +62,9 @@ namespace OpenSim.world
62 } 62 }
63 } 63 }
64 64
65 65 /// <summary>
66 /// Creates a new Entity (should not occur on it's own)
67 /// </summary>
66 public Entity() 68 public Entity()
67 { 69 {
68 uuid = new libsecondlife.LLUUID(); 70 uuid = new libsecondlife.LLUUID();
@@ -81,6 +83,10 @@ namespace OpenSim.world
81 child.addForces(); 83 child.addForces();
82 } 84 }
83 } 85 }
86
87 /// <summary>
88 /// Performs any updates that need to be done at each frame. This function is overridable from it's children.
89 /// </summary>
84 public virtual void update() { 90 public virtual void update() {
85 // Do any per-frame updates needed that are applicable to every type of entity 91 // Do any per-frame updates needed that are applicable to every type of entity
86 foreach (Entity child in children) 92 foreach (Entity child in children)
@@ -89,6 +95,10 @@ namespace OpenSim.world
89 } 95 }
90 } 96 }
91 97
98 /// <summary>
99 /// Returns a mesh for this object and any dependents
100 /// </summary>
101 /// <returns>The mesh of this entity tree</returns>
92 public virtual Mesh getMesh() 102 public virtual Mesh getMesh()
93 { 103 {
94 Mesh mesh = new Mesh(); 104 Mesh mesh = new Mesh();