PlaySoundSuccessEventArgs.cs 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. namespace GameFramework.Sound
  8. {
  9. /// <summary>
  10. /// 播放声音成功事件。
  11. /// </summary>
  12. public sealed class PlaySoundSuccessEventArgs : GameFrameworkEventArgs
  13. {
  14. /// <summary>
  15. /// 初始化播放声音成功事件的新实例。
  16. /// </summary>
  17. public PlaySoundSuccessEventArgs()
  18. {
  19. SerialId = 0;
  20. SoundAssetName = null;
  21. SoundAgent = null;
  22. Duration = 0f;
  23. UserData = null;
  24. }
  25. /// <summary>
  26. /// 获取声音的序列编号。
  27. /// </summary>
  28. public int SerialId
  29. {
  30. get;
  31. private set;
  32. }
  33. /// <summary>
  34. /// 获取声音资源名称。
  35. /// </summary>
  36. public string SoundAssetName
  37. {
  38. get;
  39. private set;
  40. }
  41. /// <summary>
  42. /// 获取用于播放的声音代理。
  43. /// </summary>
  44. public ISoundAgent SoundAgent
  45. {
  46. get;
  47. private set;
  48. }
  49. /// <summary>
  50. /// 获取加载持续时间。
  51. /// </summary>
  52. public float Duration
  53. {
  54. get;
  55. private set;
  56. }
  57. /// <summary>
  58. /// 获取用户自定义数据。
  59. /// </summary>
  60. public object UserData
  61. {
  62. get;
  63. private set;
  64. }
  65. /// <summary>
  66. /// 创建播放声音成功事件。
  67. /// </summary>
  68. /// <param name="serialId">声音的序列编号。</param>
  69. /// <param name="soundAssetName">声音资源名称。</param>
  70. /// <param name="soundAgent">用于播放的声音代理。</param>
  71. /// <param name="duration">加载持续时间。</param>
  72. /// <param name="userData">用户自定义数据。</param>
  73. /// <returns>创建的播放声音成功事件。</returns>
  74. public static PlaySoundSuccessEventArgs Create(int serialId, string soundAssetName, ISoundAgent soundAgent, float duration, object userData)
  75. {
  76. PlaySoundSuccessEventArgs playSoundSuccessEventArgs = ReferencePool.Acquire<PlaySoundSuccessEventArgs>();
  77. playSoundSuccessEventArgs.SerialId = serialId;
  78. playSoundSuccessEventArgs.SoundAssetName = soundAssetName;
  79. playSoundSuccessEventArgs.SoundAgent = soundAgent;
  80. playSoundSuccessEventArgs.Duration = duration;
  81. playSoundSuccessEventArgs.UserData = userData;
  82. return playSoundSuccessEventArgs;
  83. }
  84. /// <summary>
  85. /// 清理播放声音成功事件。
  86. /// </summary>
  87. public override void Clear()
  88. {
  89. SerialId = 0;
  90. SoundAssetName = null;
  91. SoundAgent = null;
  92. Duration = 0f;
  93. UserData = null;
  94. }
  95. }
  96. }