Trainer Party Pools

[hedara90]

Description

Allows trainers to generate their party from a curated pool of pokemon defined in the trainer party.
This feature changes nothing about trainers.party or trainers.h if it's not used.
To use this feature, simply define a Party Size that lower than the amount of defined pokemon for the trainer in trainers.party or .partySize and .poolSize in traners.h where poolSize is larger than partySize and matches the number of defined pokemon.
Optionally Pool Rules can be defined for the trainer to change which rules should be applied to the trainer.

Mons in the pool can have tags that change how the party is picked from the pool.
If a mon has the tag Lead the first mon in the party will be picked from all the pool members with this tag.
If a mon has the tag Ace the last member of the party will be picked from all the pool members with this tag.
Other tags can be marked as POOL_TAG_REQUIRED in struct PoolRules poolRules which will force that tag to be included as early as possible. (Not completely implemented right now)

Rules for the pools also include forcing unique species or NatDex numbers and unique items.
Items can also be excluded from the item uniqueness with a list.

Pool max size is currently set to 64 in trainerproc. But party generation is limited to a maximum size of 255 since index 255 is used for "No mon chosen yet".

Images

Things to note in the release changelog:

• Documentation on how to use this can be found under docs/tutorials/how_to_trainer_party_pool.md

Discord contact info

hedara

[hedara90]

Preliminarily ready for review.
Things left to do:

• Tests
• Implement pool verification

Replacement trainer for Tiana for testing.

=== TRAINER_TIANA ===
Name: TIANA
Class: Lass
Pic: Lass
Gender: Female
Music: Female
Double Battle: Yes
AI: Check Bad Move
Party Size: 3
Pool Rules: Weather Doubles

Zigzagoon
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe

Shroomish
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe

Psyduck
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe

Shellder
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe

Mew
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe
Tags: Ace

Giratina
Level: 4
IVs: 0 HP / 0 Atk / 0 Def / 0 SpA / 0 SpD / 0 Spe
Tags: Ace

Vulpix
Ability: Drought
Level: 4
Tags: Lead / Weather Setter

Torkoal
Ability: Drought
Level: 4
Tags: Lead / Weather Setter

Bulbasaur
Ability: Chlorophyll
Level: 4
Tags: Lead / Weather Abuser

Cherrim
Level: 4
Tags: Lead / Weather Abuser

[hedara90]

(Almost) ready for review, just missing pool verification.
Very much usable, assuming all pools are valid, worst case they can be padded with random mons.
Documentation is in docs/tutorials/how_to_trainer_party_pool.md

[hedara90]

Ready for review.
Do not merge before #5337

[hedara90]

Split all the pool functions into its own file.