YEP_FootstepSounds Possible Bugfix

[Mooseinthecrowd]

My project required modifying the YEP_FootstepSounds plugin, and along the way I encountered and repaired a possible bug. Specific tiles were playing the step sounds of adjacent tiles, rather than the tile the player was actually on. For example, playing grass sounds when walking on stone. It turns out the x,y used to determine the tile and corresponding tile-tag was being offset for some unknown purpose.

The fix was to remove these lines from Game_CharacterBase.prototype.playFootstepSound function:

if (this.x === 6) {
    x += 1;
  } else if (this.x === 4) {
    x -= 1;
  }
if (this.y === 2) {
    y += 1;
  } else if (this.y === 8) {
    y -= 1;
}

These lines cause off-by-one errors when using region/tile footstep sounds. I might be missing something, but to me these lines seem wholly unnecessary. They seem almost intentionally erroneous, but perhaps that's just because I don't see their intent. Perhaps the creator forgot to remove an adjustment they made specific to their game?

 

[Restart]

I believe it should be this.direction() instead of this.x and this.y. That would make it so that when playing repeated footsteps you play the ones of the next tile (ie: the tile you're moving into)

 

[Shaz]

It depends entirely on context.

I'm pretty sure if Yanfly had a bug in any plugins, they would have been brought to light a long, long time ago and fixed.

Are you sure that your mod isn't what caused the issue?

 

[Mooseinthecrowd]

These are both good points. I'll test with an unmodified version of the plugin file, the default "MoveN" sounds, and a fresh project to see if it's more likely the changes I made.

So far, with the unmodified plugin, I'm seeing the same behavior. It does seem like they could have been attempting to play the tile you were moving into. Might have been missed just because it only affects tiles in certain row/columns which are adjacent to a tile of a different sound. Here's the larger context of the issue:

// Called by processFootstepSound, which is called by both increaseSteps functions.
// Terrain tag and region ID are correct if x != 6 or 4, or y != 2 or 8
Game_CharacterBase.prototype.playFootstepSound = function(volume, pitch, pan) {
  if (volume <= 0) return;
  if (pitch <= 0) return;
  if (!$dataMap) return;
  if (!$dataMap.regionFootstepSounds) DataManager.processMapFootstepNotetags();
  var x = this.x;
  if (this.x === 6) {  // Location of possible error, results in region/terrain off-by-ones
    x += 1;
  } else if (this.x === 4) {
    x -= 1;
  }
  var y = this.y;
  if (this.y === 2) {
    y += 1;
  } else if (this.y === 8) {
    y -= 1;
  }
  var regionId = $gameMap.regionId(x, y)
  var terrainTag = $gameMap.terrainTag(x, y);
  if (regionId > 0) {
    var footstepData = $dataMap.regionFootstepSounds[regionId];
  }
  if (!footstepData && terrainTag > 0) {
    var footstepData = $gameMap.tileset().terrainTagFootstepSounds[terrainTag];
  }
  if (!footstepData) footstepData = $dataMap.regionFootstepSounds[0];
  var se = {
    name:   footstepData[0],
    volume: footstepData[1] * volume,
    pitch:  footstepData[2] * pitch,
    pan:    pan.clamp(-100, 100)
  };
  AudioManager.playSe(se);
};

// Calls playFootstepSound, does not affect terrainTag/region determination
Game_CharacterBase.prototype.processFootstepSound = function() {
  if (this.canPlayFootsteps() && $gameSystem.canHearFootsteps()) {
    var player = $gamePlayer;
    var distance = $gameMap.distance(this.x, this.y, player.x, player.y);
    var volume = Yanfly.Param.Footsteps.EventVolume || 0;
    volume += distance * Yanfly.Param.Footsteps.DistanceVolume;
    var pitch = Yanfly.Param.Footsteps.EventPitch || 0;
    pitch += distance * Yanfly.Param.Footsteps.DistancePitch;
    var pan = 0;
    pan -= $gameMap.deltaX(this.x, player.x);
    this.playFootstepSound(volume, pitch, pan);
  };
};

 

[Restart]

It depends entirely on context.

I'm pretty sure if Yanfly had a bug in any plugins, they would have been brought to light a long, long time ago and fixed.

Are you sure that your mod isn't what caused the issue?

yanfly plugins still have unpatched bugs, for example the event copier has a typo so it never runs post copy code, and always runs precopy code twice.

It says
Yanfly.Param.EventCopierPostCopy = JSON.parse(Yanfly.Parameters['PreCopyCode']);
but should say
Yanfly.Param.EventCopierPostCopy = JSON.parse(Yanfly.Parameters['PostCopyCode']);

There's no place to report them officially without spending money though