PlaySoundUpdateEventArgs.cs 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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 PlaySoundUpdateEventArgs : GameFrameworkEventArgs
  13. {
  14. /// <summary>
  15. /// 初始化播放声音更新事件的新实例。
  16. /// </summary>
  17. public PlaySoundUpdateEventArgs()
  18. {
  19. SerialId = 0;
  20. SoundAssetName = null;
  21. SoundGroupName = null;
  22. PlaySoundParams = null;
  23. Progress = 0f;
  24. UserData = null;
  25. }
  26. /// <summary>
  27. /// 获取声音的序列编号。
  28. /// </summary>
  29. public int SerialId
  30. {
  31. get;
  32. private set;
  33. }
  34. /// <summary>
  35. /// 获取声音资源名称。
  36. /// </summary>
  37. public string SoundAssetName
  38. {
  39. get;
  40. private set;
  41. }
  42. /// <summary>
  43. /// 获取声音组名称。
  44. /// </summary>
  45. public string SoundGroupName
  46. {
  47. get;
  48. private set;
  49. }
  50. /// <summary>
  51. /// 获取播放声音参数。
  52. /// </summary>
  53. public PlaySoundParams PlaySoundParams
  54. {
  55. get;
  56. private set;
  57. }
  58. /// <summary>
  59. /// 获取加载声音进度。
  60. /// </summary>
  61. public float Progress
  62. {
  63. get;
  64. private set;
  65. }
  66. /// <summary>
  67. /// 获取用户自定义数据。
  68. /// </summary>
  69. public object UserData
  70. {
  71. get;
  72. private set;
  73. }
  74. /// <summary>
  75. /// 创建播放声音更新事件。
  76. /// </summary>
  77. /// <param name="serialId">声音的序列编号。</param>
  78. /// <param name="soundAssetName">声音资源名称。</param>
  79. /// <param name="soundGroupName">声音组名称。</param>
  80. /// <param name="playSoundParams">播放声音参数。</param>
  81. /// <param name="progress">加载声音进度。</param>
  82. /// <param name="userData">用户自定义数据。</param>
  83. /// <returns>创建的播放声音更新事件。</returns>
  84. public static PlaySoundUpdateEventArgs Create(int serialId, string soundAssetName, string soundGroupName, PlaySoundParams playSoundParams, float progress, object userData)
  85. {
  86. PlaySoundUpdateEventArgs playSoundUpdateEventArgs = ReferencePool.Acquire<PlaySoundUpdateEventArgs>();
  87. playSoundUpdateEventArgs.SerialId = serialId;
  88. playSoundUpdateEventArgs.SoundAssetName = soundAssetName;
  89. playSoundUpdateEventArgs.SoundGroupName = soundGroupName;
  90. playSoundUpdateEventArgs.PlaySoundParams = playSoundParams;
  91. playSoundUpdateEventArgs.Progress = progress;
  92. playSoundUpdateEventArgs.UserData = userData;
  93. return playSoundUpdateEventArgs;
  94. }
  95. /// <summary>
  96. /// 清理播放声音更新事件。
  97. /// </summary>
  98. public override void Clear()
  99. {
  100. SerialId = 0;
  101. SoundAssetName = null;
  102. SoundGroupName = null;
  103. PlaySoundParams = null;
  104. Progress = 0f;
  105. UserData = null;
  106. }
  107. }
  108. }