BareBonesSharedModule.cs 4.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Reflection;
  29. using log4net;
  30. using Mono.Addins;
  31. using Nini.Config;
  32. using OpenSim.Region.Framework.Interfaces;
  33. using OpenSim.Region.Framework.Scenes;
  34. // You will need to uncomment these lines if you are adding a region module to some other assembly which does not already
  35. // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans
  36. // the available DLLs
  37. //[assembly: Addin("MyModule", "1.0")]
  38. //[assembly: AddinDependency("OpenSim", "0.5")]
  39. namespace OpenSim.Region.OptionalModules.Example.BareBonesShared
  40. {
  41. /// <summary>
  42. /// Simplest possible example of a shared region module.
  43. /// </summary>
  44. /// <remarks>
  45. /// This module is the simplest possible example of a shared region module (a module which is shared by every
  46. /// scene/region running on the simulator). If anybody wants to create a more complex example in the future then
  47. /// please create a separate class.
  48. ///
  49. /// This module is not active by default. If you want to see it in action,
  50. /// then just uncomment the line below starting with [Extension(Path...
  51. ///
  52. /// When the module is enabled it will print messages when it receives certain events to the screen and the log
  53. /// file.
  54. /// </remarks>
  55. //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesSharedModule")]
  56. public class BareBonesSharedModule : ISharedRegionModule
  57. {
  58. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  59. public string Name { get { return "Bare Bones Shared Module"; } }
  60. public Type ReplaceableInterface { get { return null; } }
  61. public void Initialise(IConfigSource source)
  62. {
  63. m_log.DebugFormat("[BARE BONES SHARED]: INITIALIZED MODULE");
  64. }
  65. public void PostInitialise()
  66. {
  67. m_log.DebugFormat("[BARE BONES SHARED]: POST INITIALIZED MODULE");
  68. }
  69. public void Close()
  70. {
  71. m_log.DebugFormat("[BARE BONES SHARED]: CLOSED MODULE");
  72. }
  73. public void AddRegion(Scene scene)
  74. {
  75. m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
  76. }
  77. public void RemoveRegion(Scene scene)
  78. {
  79. m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
  80. }
  81. public void RegionLoaded(Scene scene)
  82. {
  83. m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
  84. }
  85. }
  86. }