[AG] Character Noisy Steps

じ☆ve冰风

Character Noisy Steps
by Akumu Games (me)

Description:
This plugin makes characters produce stepping sound effects when they move on the map terrain.
Instructions about how to use it are explained in more detail inside.

Plugin:
Spoiler                Code:       

1. // ============================================================================
2. // Character Noisy Steps by Akumu Games
3. // ============================================================================
4. // For: RPGMAKER MV
5. // AG_CharacterNoisySteps.js
6. // Version: 1.2.1
7. // Free to use for commercial and non commercial projects as long as proper credit is given.
8. // ============================================================================
9. /*:
10. * @plugindesc Characters will produce stepping sound effects when they move on the map terrain.
11. *
12. * @author Akumu Games
13. * ============================================================================
14. * @param Player Step SE Volume
15. * @desc The volume at which stepping sound effect will play for the player.
16. * @default 40
17. * @param Events Step SE Volume
18. * @desc The volume at which stepping sound effect will play for events.
19. * @default 20
20. * @param Step SE Pitch
21. * @desc The pitch at which stepping sound effect will play for characters.
22. * @default 100
23. * @param Pitch Variance
24. * @desc The range at which the pitch can oscillate between (placing this value at 0 will null this feature).
25. * @default 5
26. * @param Pan Variance
27. * @desc The pan difference that will play when an event is located to the right/left from the player (placing this value at 0 will null this feature).
28. * @default 40
29. * @param Disable Player Noisy Steps Switch ID
30. * @desc When this switch is turned ON, the player won't produce stepping sound effects.
31. * @default 0
32. * @param Disable Events Noisy Steps Switch ID
33. * @desc When this switch is turned ON, all events on the map won't produce stepping sound effects.
34. * @default 0
35. * @param Terrain Tag 0 SE
36. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 0.
37. * @default
38. * @param Terrain Tag 1 SE
39. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 1.
40. * @default concrete
41. * @param Terrain Tag 2 SE
42. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 2.
43. * @default sand
44. * @param Terrain Tag 3 SE
45. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 3.
46. * @default carpet
47. * @param Terrain Tag 4 SE
48. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 4.
49. * @default grass
50. * @param Terrain Tag 5 SE
51. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 5.
52. * @default metal
53. * @param Terrain Tag 6 SE
54. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 6.
55. * @default wood
56. * @param Terrain Tag 7 SE
57. * @desc Stepping sound effect file name assigned to tiles with terrain tag: 7.
58. * @default dirt
59. * @param Size Tag Pitch Increment
60. * @desc Pitch increment/decrement for event tag <Size:Big|Tiny> (placing this value at 0 won't have any effect).
61. * @default 40
62. * @param Special Tag 1 SE
63. * @desc Stepping sound effect file name assigned to event tag <Special:1>.
64. * @default robot
65. * @param Special Tag 2 SE
66. * @desc Stepping sound effect file name assigned to event tag <Special:2>.
67. * @default wheels
68. * @param Special Tag 3 SE
69. * @desc Stepping sound effect file name assigned to event tag <Special:3>.
70. * @default claws
71. * @param Special Tag 4 SE
72. * @desc Stepping sound effect file name assigned to event tag <Special:4>.
73. * @default chains
74. * @param Special Tag 5 SE
75. * @desc Stepping sound effect file name assigned to event tag <Special:5>.
76. * @default dragged
77. * ============================================================================
78. * @help
79. * ============================================================================
80. * Intructions
81. * ============================================================================
82. *
83. * Once you have assigned terrain tag IDs to the tileset and configured the plugin
84. * parameters accordingly, you can then tag a map event to produce stepping sound
85. * effects by simply placing the string "<NPC>" somewhere in its event note input
86. * field.
87. * You can also employ special tags to events in order to replace the default
88. * tileset stepping SE. This is useful for events that walk around the map in an
89. * unique pattern (like for example an evil demon with claws in their feet).
90. * For this, simply tag the event with "<Special:N>", where N is the number of
91. * the special stepping SE you previously indicated in the plugin parameters.
92. * If you don't wish an event to play both, the terrain and special stepping SE
93. * simultaneously, add the tag "<SpecialOnly>".
94. * The other special tag is "<Size:Big|Tiny>". This is designed to create a more
95. * powerful or subtle stepping SE for events bigger/smaller than normal. This
96. * effect is simulated by increase/decreasing the stepping SE pitch when played.
97. * As always, make sure to change the plugin parameters for this as required.
98. *
99. * Keep in mind:
100. *     - The player will always make noisy steps unless the designated switch
101. * is turned ON.
102. *     - If a map event is off the screen or its priority is above player, it
103. * won't make noisy steps.
104. *     - Characters will only make noisy steps if their Walking Animation flag
105. * is ON.
106. *
107. * All stepping sound effects must be placed in the "Audio/SE" game folder, just
108. * like any other SE you often use :) You can import them from the editor or
109. * manually. Have fun!
110. *
111. * ============================================================================
112. * Plugin Commands
113. * ============================================================================
114. *
115. * You can use the following plugin command to change the sound effect assigned
116. * to a terrain tag:
117. *      SetTerrainTagSE <terrainTagId> <SE file name>
118. *
119. *    examples: SetTerrainTagSE 1 Water
120. *              SetTerrainTagSE 3
121. *
122. * Also, if for some reason you require to disable noisy steps for a single
123. * event, you can use the following script call:
124. *      setNoisyStepsDisabled(flag)
125. *
126. *    examples: $gameMap.event(5).setNoisyStepsDisabled(true);
127. *              $gameMap.event(this._eventId).setNoisyStepsDisabled(true);
128. * ============================================================================
129. */
131. //=============================================================================
132. // Parameter Variables
133. //=============================================================================
134. (function() {
135.   
136.     var parameters = PluginManager.parameters('AG_CharacterNoisySteps');
137.     var _playerStepSEVolume = Number(parameters['Player Step SE Volume'] || '0');
138.     var _eventsStepSEVolume = Number(parameters['Events Step SE Volume'] || '0');
139.     var _stepSEPitch = Number(parameters['Step SE Pitch'] || '100');
140.     var _pitchVariance = Number(parameters['Pitch Variance'] || '0');
141.     var _panVariance = Number(parameters['Pan Variance'] || '0');
142.     var _disablePlayerNoisyStepsSwitch = Number(parameters['Disable Player Noisy Steps Switch ID'] || 0);
143.     var _disableEventsNoisyStepsSwitch = Number(parameters['Disable Events Noisy Steps Switch ID'] || 0);
144.     var _terrainTagSE = [String(parameters['Terrain Tag 0 SE'] || ''),
145.                          String(parameters['Terrain Tag 1 SE'] || ''),
146.                          String(parameters['Terrain Tag 2 SE'] || ''),
147.                          String(parameters['Terrain Tag 3 SE'] || ''),
148.                          String(parameters['Terrain Tag 4 SE'] || ''),
149.                          String(parameters['Terrain Tag 5 SE'] || ''),
150.                          String(parameters['Terrain Tag 6 SE'] || ''),
151.                          String(parameters['Terrain Tag 7 SE'] || '')];
152.     var _sizeTagPitch = Number(parameters['Size Tag Pitch Increment'] || '0');
153.     var _specialTagSE = [String(parameters['Special Tag 1 SE'] || ''),
154.                          String(parameters['Special Tag 2 SE'] || ''),
155.                          String(parameters['Special Tag 3 SE'] || ''),
156.                          String(parameters['Special Tag 4 SE'] || ''),
157.                          String(parameters['Special Tag 5 SE'] || '')];
158.   
159.     function isPlayerNoisyStepsDisabled(){
160.         return $gameSwitches.value(_disablePlayerNoisyStepsSwitch);
161.     }
162.   
163.     function isEventsNoisyStepsDisabled(){
164.         return $gameSwitches.value(_disableEventsNoisyStepsSwitch);
165.     }
166.   
167.     function getRandomRangeInt(min, max) {
168.         return Math.floor(Math.random() * (max - min + 1) + min);
169.     }
171. //=============================================================================
172. // Game_Interpreter
173. //=============================================================================
175.     var Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;
176.     Game_Interpreter.prototype.pluginCommand = function(command, args) {
177.         Game_Interpreter_pluginCommand.call(this, command, args)
178.         if (command === 'SetTerrainTagSE'){
179.             var terrainTag = args[0];
180.             if (terrainTag >= 0 && terrainTag <= 7){
181.                 _terrainTagSE[terrainTag] = args[1];
182.             }
183.         }
184.     };
185.   
186. //=============================================================================
187. // Game_CharacterBase
188. //=============================================================================
189.   
190.     Game_CharacterBase.prototype._noisyStep = false;
191.     Game_CharacterBase.prototype._noisyStepWaitCount = 0;
192.   
193.     var characterNoisySteps_Game_CharacterBase_update = Game_CharacterBase.prototype.update;
194.     Game_CharacterBase.prototype.update = function() {
195.         this.performNoisyStep();
196.         if(this._noisyStep){
197.             this.resetNoisyStepWaitCount();
198.         }else if(this._noisyStepWaitCount > 0){
199.             this._noisyStepWaitCount--;
200.         }
201.         characterNoisySteps_Game_CharacterBase_update.call(this);
202.     };
203.   
204.     var characterNoisySteps_Game_CharacterBase_setMoveSpeed = Game_CharacterBase.prototype.setMoveSpeed;
205.     Game_CharacterBase.prototype.setMoveSpeed = function(moveSpeed) {
206.         characterNoisySteps_Game_CharacterBase_setMoveSpeed.call(this, moveSpeed);
207.         this.resetNoisyStepWaitCount();
208.     };
209.   
210.     Game_CharacterBase.prototype.resetNoisyStepWaitCount = function() {
211.         this._noisyStepWaitCount = 256/Math.pow(2, this.realMoveSpeed());
212.         this._noisyStep = false;
213.     };
214.   
215.     Game_CharacterBase.prototype.isNPC = function() {
216.         return false;
217.     };
218.   
219.     Game_CharacterBase.prototype.performNoisyStep = function() { };
221. //=============================================================================
222. // Game_Player
223. //=============================================================================
224.   
225.     Game_Player.prototype.performNoisyStep = function() {
226.         if(!isPlayerNoisyStepsDisabled() && this.hasWalkAnime() && this._noisyStepWaitCount == 0 && this.isMoving()){
227.             this.playNoisyStep();
228.             this._noisyStep = true;
229.         }
230.     };
231.   
232.     Game_Player.prototype.playNoisyStep = function() {
233.         var pitch = getRandomRangeInt(_stepSEPitch - _pitchVariance, _stepSEPitch + _pitchVariance);
234.         AudioManager.playSe({ name: _terrainTagSE[this.terrainTag()], volume: _playerStepSEVolume, pitch: pitch, pan: 0 });
235.     };
237. //=============================================================================
238. // Game_Event
239. //=============================================================================
240.   
241.   
242.     var characterNoisySteps_Game_Event_initMembers = Game_Event.prototype.initMembers;
243.     Game_Event.prototype.initMembers = function() {
244.         characterNoisySteps_Game_Event_initMembers.call(this);
245.         this._noisyStepsDisabled = false;
246.     };
247.   
248.     Game_Event.prototype.performNoisyStep = function() {
249.         if(!isEventsNoisyStepsDisabled() && !this._noisyStepsDisabled && this.isNPC() && this.isNearTheScreen() && this._priorityType < 2 && this.hasWalkAnime() && this._noisyStepWaitCount == 0 && this.isMoving()){
250.             if(!this.isSpecialOnly()){
251.                 this.playNoisyStep();
252.             }
253.             this.playSpecialNoisyStep();
254.             this._noisyStep = true;
255.         }
256.     };
257.   
258.     Game_Event.prototype.playNoisyStep = function() {
259.         var pitch = getRandomRangeInt(_stepSEPitch - _pitchVariance, _stepSEPitch + _pitchVariance) + _sizeTagPitch*this.sizeMultiplier();
260.         var pan = _panVariance * this.panVarianceOffset($gamePlayer);
261.         AudioManager.playSe({ name: _terrainTagSE[this.terrainTag()], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });
262.     };
263.   
264.     Game_Event.prototype.playSpecialNoisyStep = function() {
265.         if(this.isSpecial()){
266.             var pitch = getRandomRangeInt(_stepSEPitch - _pitchVariance, _stepSEPitch + _pitchVariance) + _sizeTagPitch*this.sizeMultiplier();
267.             var pan = _panVariance * this.panVarianceOffset($gamePlayer);
268.             if(this.event().note.indexOf('<Special:1>') != -1){
269.                 AudioManager.playSe({ name: _specialTagSE[0], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });  
270.             }
271.             if(this.event().note.indexOf('<Special:2>') != -1){
272.                 AudioManager.playSe({ name: _specialTagSE[1], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });  
273.             }
274.             if(this.event().note.indexOf('<Special:3>') != -1){
275.                 AudioManager.playSe({ name: _specialTagSE[2], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });  
276.             }
277.             if(this.event().note.indexOf('<Special:4>') != -1){
278.                 AudioManager.playSe({ name: _specialTagSE[3], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });  
279.             }
280.             if(this.event().note.indexOf('<Special:5>') != -1){
281.                 AudioManager.playSe({ name: _specialTagSE[4], volume: _eventsStepSEVolume, pitch: pitch, pan: pan });  
282.             }
283.         }
284.     };
285.   
286.     Game_Event.prototype.panVarianceOffset = function(character) {
287.         if(character._x < this._x){
288.             return 1;
289.         }
290.         else if(character._x > this._x){
291.             return -1;
292.         }
293.         else{
294.             return 0;
295.         }
296.     };
297.   
298.     Game_Event.prototype.isNPC = function() {
299.         return this.event().note.indexOf('<NPC>') != -1;
300.     };
301.   
302.     Game_Event.prototype.isSpecial = function() {
303.         return this.event().note.indexOf('<Special:') != -1;
304.     };
305.   
306.     Game_Event.prototype.isSpecialOnly = function() {
307.         return this.event().note.indexOf('<SpecialOnly>') != -1;
308.     };
309.   
310.     Game_Event.prototype.sizeMultiplier = function() {
311.         if(this.event().note.indexOf('<Size:Tiny>') != -1){
312.             return 1;
313.         }else if(this.event().note.indexOf('<Size:Big>') != -1){
314.             return -1;
315.         }else{
316.             return 0;
317.         }
318.     };
319.   
320.     Game_Event.prototype.setNoisyStepsDisabled = function(flag) {
321.         this._noisyStepsDisabled = flag;
322.     };
323. })();

复制代码

(save as "AG_CharacterNoisySteps.js" in your plugins folder)

Credits:
Author: Akumu Games

Notes:
I don't think anyone has made a feature like this one yet. Kinda weird if you ask me.. As the n00b I'm I tried to come up with something while learning JS. I, personally, gonna find it very useful in my projects  


Please, let me know if you find any glitch (very probable because I'm very tired right now D
.


本贴来自国际rpgmaker官方论坛作者:Kyuukon处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/ag-character-noisy-steps.65357/