Remove form change function footguns #5995
Merged
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.
Description
Currently, when form changes are checked, the functions return
SPECIES_NONE
if they won't change form in the current conditions and this is checked on all their uses. However, should a user forget to check forSPECIES_NONE
, their mon will essentially be deleted due to setting their species toSPECIES_NONE
. This PR aims to fix this by changing the functions into returning the current species, along with updating their checks.Already tested with item hold, weather and Gigantamax form changes, so I'd be safe to say that all of them work correctly. Feel free to test indepth if you desire.
People who collaborated with me in this PR
@AlexOn1ine for letting me know of this potential issue.
Things to note in the release changelog:
GetBattleFormChangeTargetSpecies
,GetFormChangeTargetSpecies
andGetFormChangeTargetSpeciesBoxMon
now return the current species of the Pokémon instead ofSPECIES_NONE
as a precaution to avoid accidental deletions of Pokémon when using these functions.Discord contact info
AsparagusEduardo