Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cleaned up Trainer Slides, added automated Trainer Slide tests, add new Enemy Critical Hit Slide #6018

Open
wants to merge 56 commits into
base: upcoming
Choose a base branch
from
Open

Cleaned up Trainer Slides, added automated Trainer Slide tests, add new Enemy Critical Hit Slide #6018

wants to merge 56 commits into from
+964 −301

Conversation

pkmnsnfrn
Copy link
Collaborator

@pkmnsnfrn pkmnsnfrn commented Jan 13, 2025 •
edited
Loading

Description

  • Consolidated trainerSlideFirstCriticalHitMsgState, trainerSlideFirstSuperEffectiveHitMsgState, trainerSlideFirstSTABMoveMsgState, trainerSlidePlayerMonUnaffectedMsgState, trainerSlideHalfHpMsgDone, trainerSlideMegaEvolutionMsgDone, trainerSlideZMoveMsgDone, trainerSlideBeforeFirstTurnMsgDone, trainerSlideDynamaxMsgDone, and trainerSlideLowHpMsgDone into slideMessageStatus.
  • Moved trainer slide logic out of src/battle_message.c and into its own file, trainer_slide.c.
  • Rewrote the functions that control if a specific Trainer Slide should be played.
  • Renamed members of the TrainerSlideType enum to be more clear.
  • Simplied trainer slide calls in src/battle_script_commands.c and src/battle_util.c.
  • Created tests for all existing trainer slides.
  • Added new slide for when enemy lands their first critical hit.
  • Added documentation on adding new trainer slides.

Images

Gif of two automated tests for Trainer Slides running

People who collaborated with me in this PR

@AlexOn1ine, @hedara90, @AsparagusEduardo, @mrgriffin

Feature(s) this PR does NOT handle:

#5565

Things to note in the release changelog:

  • If users created new entries in sTrainerSlides, they will need to be ported to the new system.

Discord contact info

pkmnsnfrn

There is a discussion thread: https://discord.com/channels/419213663107416084/1325604832337465426

pkmnsnfrn added 30 commits January 5, 2025 16:29
@pkmnsnfrn
Moved trainer slides to their own file
daa2282 
Moved trainer slide check conditions to their own functions
@pkmnsnfrn
Reindent file
713e180 
Made each trainer a member of the trainerSlides struct
Removed iterating over the entire struct
@pkmnsnfrn
First version of slides without for loop is working
5e98ad0
@pkmnsnfrn
Seperated frontier trainer into their own struct
60e34e3
@pkmnsnfrn
Reordered functions in trainer slide file
1584760
@pkmnsnfrn
Changed names to make it clear that the condition is for the player t…
9636df5 
…o land hits
@pkmnsnfrn
Reorder functions in switch to match enum
307f5f7
@pkmnsnfrn
Renamed PlayerMonUnaffected to EnemyMonUnaffected
b2fe29d
@pkmnsnfrn
Renamed PlayerMonUnaffected to EnemyMonUnaffected
5eba4f9
@pkmnsnfrn
Added ShouldInitializeFirstSTABMoveTrainerSlide
d4e32c1
@pkmnsnfrn
Fixed bug with ShouldRunTrainerSlideLastHalfHP
674e70e
@pkmnsnfrn
Renamed ShouldInitalizeFirstSTABMoveTrainerSlide to TryInitalizeFirst…
63a620c 
…STABMoveTrainerSlide

Fixed bug where STAB Trainer Slide was being set too eagerly
@pkmnsnfrn
Removed trainerSlide struct and replced with u8 array
dcc0ce5
@pkmnsnfrn
Introduced IsTrainerSlideInitialized
f3c2862 
IsTrainerSlidePlayed
InitalizeTrainerSlide
MarkTrainerSlideAsPlayed
@pkmnsnfrn
Updated before first turn
038da37
@pkmnsnfrn
Rolled out use of DoesTrainerHaveSlideMessage
1c3f182
@pkmnsnfrn
Removed all old members of struct
6e193ee
@pkmnsnfrn
Added TrainerSlideTargets enum and changed type of ShouldDoTrainerSlide
219da5d 
Moved ShoudldRun from header to main file
Deleted DebugPrintFlippedBits
Added sShouldRunTrainerSlideFunctions Table
Added checking for frontier trainers in DOesTrainerHaveSLideMessage
Created SetTrainerSlideMessage
Changed all aruguments for ShouldRun functions to be unified
Created SetTrainerSlideParamters
Removed switch statement from ShouldDoTrainerSlide and replaced with function table
@pkmnsnfrn
enforced types on slideId and renamed variable
579358a
@pkmnsnfrn
Moved Played and HaveMessage checks up one level
01ef315
@pkmnsnfrn
Created IsSlideinitalizedOrPlayed
ba75cb1
@pkmnsnfrn
Removed retValue from header
ac9fbc6
@pkmnsnfrn
Fixed function headers
d184a6f
@pkmnsnfrn
Replaced HP check with IsBattlerAlive
52b3ff8
@pkmnsnfrn
Added checks to SanitizeTrainerId so tests don't fail
697d9b5
@pkmnsnfrn
Added sTestTrainerSlides
2b68196 
Added first working test
@pkmnsnfrn
Moved sTest into its own file
eadb65a
@pkmnsnfrn
Add first critical hit test
2b765f6
@pkmnsnfrn
Updated spacing
950338f
@pkmnsnfrn
Added template for remaining work
5f88b63
@pkmnsnfrn
Updated last half hp test
7753d00
@pkmnsnfrn
Updated Mega slide test
2ad7f67
@pkmnsnfrn
Updated Z MOve Trainer Slide test
32848b8
@pkmnsnfrn
Updated most tests
829a7e0
@pkmnsnfrn
Removed function table and replaced with switch
3516c98
@pkmnsnfrn
Moved if statements out of functions per https://discord.com/channels…
bab614c 
…/419213663107416084/1325604832337465426/1328111261011148811
@pkmnsnfrn
Restored files
f11e018
@pkmnsnfrn
Cleaned up some defines
f996725
@pkmnsnfrn
Removed testing code
78f16ab
@pkmnsnfrn
Added new trainer slide: Enemy Mon Lands First Critical Hit
15a2f1a
@pkmnsnfrn
Fixed Mega test to not rely on names
c0222e4
@pkmnsnfrn
Corrected spacing
bc8b9a9
@pkmnsnfrn
Revert "Added new trainer slide: Enemy Mon Lands First Critical Hit"
905d471 
This reverts commit 15a2f1a.
@pkmnsnfrn
Added new trainer slide: Enemy Mon Lands First Critical Hit
d642468
@pkmnsnfrn
Added static assert to prevent users from adding more than 32 Trainer…
12a0731 
… Slides
@pkmnsnfrn
Updated tutorial
5c34c20
@pkmnsnfrn
Updated SUMMARY.md
b38fec7
@pkmnsnfrn
reset trainers.h
10bf553
lhearachel
lhearachel reviewed Jan 13, 2025
View reviewed changes
include/trainer_slide.h Outdated Show resolved Hide resolved
src/trainer_slide.c Outdated Show resolved Hide resolved
@pkmnsnfrn pkmnsnfrn added type: documentation Improvements or additions to documentation category: battle-mechanic Pertains to battle mechanics type: cleanup category: battle-tests Related to the automated test environment type: refactor type: big feature A feature with big diffs and / or high impact / subjectivity / pervasiveness labels Jan 13, 2025
@pkmnsnfrn pkmnsnfrn marked this pull request as ready for review January 15, 2025 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lhearachel lhearachel lhearachel left review comments

@AlexOn1ine AlexOn1ine AlexOn1ine left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
category: battle-mechanic Pertains to battle mechanics category: battle-tests Related to the automated test environment type: big feature A feature with big diffs and / or high impact / subjectivity / pervasiveness type: cleanup type: documentation Improvements or additions to documentation type: refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pkmnsnfrn @AlexOn1ine @lhearachel