ITerrainModifier.cs 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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 OpenSim.Region.Framework.Interfaces;
  29. namespace OpenSim.Region.CoreModules.World.Terrain
  30. {
  31. public interface ITerrainModifier
  32. {
  33. /// <summary>
  34. /// Creates the feature.
  35. /// </summary>
  36. /// <returns>
  37. /// Empty string if successful, otherwise error message.
  38. /// </returns>
  39. /// <param name='map'>
  40. /// ITerrainChannel holding terrain data.
  41. /// </param>
  42. /// <param name='args'>
  43. /// command-line arguments from console.
  44. /// </param>
  45. string ModifyTerrain(ITerrainChannel map, string[] args);
  46. /// <summary>
  47. /// Gets a string describing the usage.
  48. /// </summary>
  49. /// <returns>
  50. /// A string describing parameters for creating the feature.
  51. /// Format is "feature-name <arg1> <arg2> ..."
  52. /// </returns>
  53. string GetUsage();
  54. /// <summary>
  55. /// Apply the appropriate operation on the specified map, at (x, y).
  56. /// </summary>
  57. /// <param name='map'>
  58. /// Map.
  59. /// </param>
  60. /// <param name='data'>
  61. /// Data.
  62. /// </param>
  63. /// <param name='x'>
  64. /// X.
  65. /// </param>
  66. /// <param name='y'>
  67. /// Y.
  68. /// </param>
  69. double operate(double[,] map, TerrainModifierData data, int x, int y);
  70. }
  71. }