sim: remove redundant KillUnit() parameter
#963
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nbusseneau
force-pushed
the
pr/remove-redundant-killunit-param
branch
from
1f4adc9 to
77acc9c
Compare
sprunk
reviewed
Aug 21, 2023
Previously, `KillUnit()` (and its variants) exposed an optional `showDeathSequence` parameters that defaulted to `true`, and if set to `false` then no death script was run. In this commit, we remove the parameter as it is entirely redundant: - The 3rd mandatory parameter `reclaimed` is used for exactly the same purpose: if `reclaimed` is `true`, then no death script is run. - The default value of `showDeathSequence` is `true` and none of the callers actually set it to `false`, except 1, but this one also sets `reclaimed` to `true`... thereby overriding `showDeathSequence`.
nbusseneau
force-pushed
the
pr/remove-redundant-killunit-param
branch
from
77acc9c to
ee146a7
Compare
sprunk
approved these changes
Aug 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously,
KillUnit()(and its variants) exposed an optionalshowDeathSequenceparameters that defaulted totrue, and if set tofalsethen no death script was run.In this commit, we remove the parameter as it is entirely redundant:
reclaimedis used for exactly the same purpose: ifreclaimedistrue, then no death script is run.showDeathSequenceistrueand none of the callers actually set it tofalse, except 1, but this one also setsreclaimedtotrue... thereby overridingshowDeathSequence.