add a comment

from the commitmessage of 3d280bbc3d

I think this comment is quiet important for someone who might want to change this code, and there might be people who are too lazy to find the commit where this information was, so i added it to the code.
This commit is contained in:
gfgtdf 2015-01-14 03:53:56 +01:00
parent ea32d33833
commit 2e875d66f6

View file

@ -165,6 +165,11 @@ SYNCED_COMMAND_HANDLER_FUNCTION(attack, child, /*use_undo*/, show, error_handler
const map_location dst(destination, resources::gamedata);
int weapon_num = child["weapon"];
// having defender_weapon in the replay fixes a bug (OOS) where one player (or observer) chooses a different defensive weapon.
// Xan pointed out this was a possibility: we calculate defense weapon
// now based on attack_prediction code, but this uses floating point
// calculations, which means that in the case where results are close,
// rounding differences can mean that both ends choose different weapons.
int def_weapon_num = child["defender_weapon"].to_int(-2);
if (def_weapon_num == -2) {
// Let's not gratuitously destroy backwards compatibility.