1
0

IBehaviour.cs 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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. namespace pCampBot.Interfaces
  29. {
  30. public interface IBehaviour
  31. {
  32. /// <summary>
  33. /// Abbreviated name of this behaviour.
  34. /// </summary>
  35. string AbbreviatedName { get; }
  36. /// <summary>
  37. /// Name of this behaviour.
  38. /// </summary>
  39. string Name { get; }
  40. /// <summary>
  41. /// Initialize the behaviour for this bot.
  42. /// </summary>
  43. /// <remarks>
  44. /// This must be invoked before Action() is called.
  45. /// </remarks>
  46. /// <param name="bot"></param>
  47. void Initialize(Bot bot);
  48. /// <summary>
  49. /// Close down this behaviour.
  50. /// </summary>
  51. /// <remarks>
  52. /// This is triggered if a behaviour is removed via explicit command and when a bot is disconnected
  53. /// </remarks>
  54. void Close();
  55. /// <summary>
  56. /// Action to take when this behaviour is invoked.
  57. /// </summary>
  58. /// <param name="bot"></param>
  59. void Action();
  60. }
  61. }