Script: Legendary Breeding [v20.1]

[Lucidious89]

Legendary Breeding for v20.1
A mod that assigns new Egg Groups to Legendary Pokemon to allow them to breed and produce Legendary eggs!

Overview
This plugin revamps the data for all Legendary, Mythical, and Ultra Beast species so that they now have genders, and are capable of producing eggs and inheriting Egg Moves. Eight new exclusive Egg Groups are included that only Legendary species may occupy which allow them to breed with each other, but not with regular species found in other Egg Groups. This still keeps Legendaries a bit special by separating into their own groups, while allowing them to still utilize all the benefits of breeding.

A new feature called Paradox Engineering has also been included starting with Gen 9, with the inclusion of Paradox species. This works functionally similar to breeding, but it has a variety of differences. The details of which can be found in the information section below.

Plugin Features

• Introduces eight new Egg Groups that only Legendary species occupy.
• Updated PBS data for all existing Legendary species which include new gender ratios, egg groups, egg moves, and more.
• PBS data is auto-compiled, so you don't have to manually edit any files to apply this new data.
• Inclusion of a file to easily restore your PBS data back to default if you decide to remove this plugin.
• Introduces three new items used for special breeding cases - Berserk Gene, Divine Plate, and False Plate. PBS data and sprites included.
• Special breeding mechanics introduced for certain species.
• The ability to customize which baby species is produced based on a parent's held item.
• Brand new mechanic known as Paradox Engineering included exclusively for "breeding" Gen 9's Paradox species.
• Full compatibility with my Enhanced UI plugin to allow the new Legendary Egg Groups to be displayed in the Summary/Pokedex.

-DOWNLOAD LINK-


Installation

Spoiler:

• Download and install the latest version of the Essentials Deluxe plugin. To reiterate, this is required for this plugin to work.
• Download this plugin using the link provided and extract its contents to your root Essentials folder.
• Before loading up your game, make sure to tweak the Egg Moves for each species to your liking in the file located in PBS/Plugins/Legendary Breeding/pokemon.txt. This file is automatically deleted upon loading the game, so any edits must be done prior.
• Your game should auto-compile all the necessary files upon loading the game in debug mode after installing. If this does not happen for some reason, you can force the game to compile by holding down the CTRL button upon opening the game window.
• IMPORTANT: If you plan on using other plugins that replaces or overwrites your entire Items, Pokemon or PokemonForms PBS files, such as the Gen 9 Pack, then you must install this plugin AFTER installing those first. If you install this plugin first, then any PBS changes applied by this plugin will be overwritten the second those plugins are installed, thus rendering this plugin useless. Please keep that in mind before claiming that this plugin doesn't work.

Changelog (v1.0.3 FINAL VERSION)

Spoiler:

• FINAL UPDATE 1.0.3
  • Many new game statistics may now be tracked.
• 1.0.2
  • Added Walking Wake and Iron Leaves to the list of Paradox species that can be created through Paradox Engineering.
  • Added Egg Moves for all Paradox species.
• 1.0.1
  • Updated the Pokemon PBS data to now include breeding data for Gen 9 Legendaries: Ting-Lu, Chien-Pao, Wo-Chien, and Chi-Yu.
  • Removed Magearna from being a breedable species, as it really doesn't make any sense for a literal robot to produce Eggs in any way.
  • Refined the Egg Move lists for all species; condensing them, and removing instances of all moves that appear as TM's as of Gen 9.
  • Updated the PBS data for all relevant items added by this plugin to now utilize the PortionName and PortionNamePlural properties, to allow for compatibility with the Improved Item Text plugin.
  • Changed any item text displays utilized by the plugin to now display portion name text wherever appropriate.
  • Added the Paradox Engineering mechanic.

Information

Legendary Egg Groups​

Spoiler:

This group is primarily occupied by bird-like or winged species that dominate the skies.
Pokemon in this group:

This group is primarily occupied by beast-like species that roam the lands. Most species in this group are quadrupeds.
Pokemon in this group:

This is a small group made up primarily by large, hulking species.
Pokemon in this group:

This is a small group made up primarily by Dragon-type species.
Pokemon in this group:

This group is primarily occupied by creatures with mysterious or cosmic origins. Most species in this group are bipedal, or align themselves vertically.
Pokemon in this group:

This group is primarily occupied by pixie-like species with strong ties to nature or other magical properties. Most species in this group are smaller in size.
Pokemon in this group:

This group is occupied by the genetic ancestor to all other species. This group can breed with every other group except for the Ditto and Ultra groups.
Pokemon in this group:

This group is occupied only by Ultra beasts, or species with similar cosmic origins.
Pokemon in this group:

Special Cases​

Spoiler:

• 
  
  Ditto
  Ditto cannot breed with any species in any Legendary Egg Group. This includes both Mew and Ultra Beasts.
  
  
  
• 
  
  Mew
  Mew functions a lot like Ditto, but with extra functionality. Since Mew carries the DNA of all other species, it only makes sense that it can breed with most of them. Mew can breed with any of the normal egg groups (besides Ditto), and any of the Legendary Egg Groups (besides Ultra). When breeding with Mew, the egg species will always be that of Mew's partner (again, just like how Ditto functions). However, unlike Ditto, Mew can breed with itself to create more Mew. The one downside to breeding with Mew instead of Ditto is that Mew have genders. So gender-based compatibility rules still apply when breeding with Mew.
  
  
  
• 
  
  Mewtwo
  Mewtwo remains unchanged, and is incapable of breeding. As a mutated science experiment gone wrong, its genes are far too corrupted to breed with anything. However, you can still create Mewtwo eggs if two Mew are bred while either parent is holding a Berserk Gene. This will corrupt the offspring's DNA, creating a Mewtwo egg instead.
  
  
  
• 
  
  
  
  Regional Forms
  As with any regional form, the species will always hatch in its appropriate form depending on which region the egg is hatched in. However, you can override this and force the egg to hatch in the form of its mother when it is holding an Everstone.
  
  
  
• 
  
  
  
  
  
  Regirock, Regice, Registeel, Regieleki, Regidrago
  These species remain unchanged, and are incapable of breeding. They were not born through normal means, and were instead crafted by Regigigas out of natural resources. However, you can still create Regi eggs by breeding two Regigigas together while either parent is holding an item made of the appropriate material.
  
  
  • Regirock: Parent must be holding a Hard Stone.
  • Regice: Parent must be holding a Never-Melt Ice.
  • Registeel: Parent must be holding an Iron Ball.
  • Regieleki: Parent must be holding a Light Ball.
  • Regidrago: Parent must be holding a Dragon Fang.
  
  
  
• 
  
  
  Latias & Latios
  Latias has a 50% chance of producing either Latias or Latios eggs. Much like how female Nidoran can produce the male or female variants. The same thing occurs if Latios is bred with a female Mew.
  
  
  
• 
  
  Deoxys
  Deoxys eggs will inherit its mother's form when hatched (or father's form when bred with Mew).
  
  
  
• 
  
  
  
  Dialga, Palkia, Giratina
  These species remain unchanged, and are incapable of breeding. As beings that existed at the creation of the universe, their biology is beyond other species. However, you can still create eggs of these Pokemon by utilizing a unique mechanic with Arceus (more on this below).
  
  
  
• 
  
  Arceus
  Arceus remains unchanged, and is incapable of breeding. However, a unique mechanic exclusive to Arceus is implemented that allows it to spawn eggs through its own power, depending on the item its holding. When equipped with specific items, a new option will appear in Arceus' command menu in the party screen called "Form Egg" in orange text. When selecting this option, Arceus will be able to utilize the inherent power of its held item to form an egg of certain species, depending on the item held. Here are all of the potential species Arceus may form an egg of:
  
  
  • Dialga: Creates an egg of this species when an Adamant Orb is held.
  • Palkia: Creates an egg of this species when a Lustrous Orb is held.
  • Giratina: Creates an egg of this species when a Griseous Orb is held.
  • Arceus: Creates an egg of this species when a Divine Plate is held. This item is destroyed in the process.
  • Type: Null: Creates an egg of this species when a False Plate is held. This item is destroyed in the process.
  
  
  
• 
  
  
  Phione & Manaphy
  Breeding either Phione or Manaphy will always produce Phione eggs. However, if either one is holding a Mystic Water while breeding, this will produce Manaphy eggs instead.
  
  
  
• 
  
  
  
  
  Tornadus, Thundurus, Landorus, Enamorus
  These species can only breed while in their Therian forms, as their biology matches other species the most while in these forms.
  
  
  
• 
  
  
  Zygarde
  Zygarde will always hatch in its 10% form when breeding. However, Zygarde 10% itself cannot breed, as it has too few cells to do so successfully. It must reach its 50% form before it's capable of breeding.
  
  
  
• 
  
  
  Type: Null, Silvally
  These species remain unchanged, and are incapable of breeding. Much like Mewtwo, their genes have been corrupted too thoroughly through genetic experiment to breed. However, as described in the Arceus section, you can create Type: Null eggs if you use Arceus to spawn an egg while its holding a False Plate.
  
  
  
• 
  
  
  Solgaleo & Lunala
  These species are unique in that they have different egg groups despite being of the same evolutionary family. Solgaleo is in the Bestial group, while Lunala is in the Skycrest group. However, both overlap in the Ultra group. These are the only species (along with Necrozma) that bridge the gap between Ultra Beast and non-Ultra Beast species.
  
  You may acquire Egg Moves onto Cosmog, but keep in mind that by default, Solgaleo is listed as a male-only species. So only Lunala will be able to inherit and pass down moves. This is because Mew cannot breed with these species since they are in the Ultra group, so the only way to create a Cosmog egg is through Lunala.
  
  
  
• 
  
  Magearna
  Because this Pokemon is just literally a robot and has no natural biology whatsoever, it's difficult to find a logical way to include it in any Egg Groups. Because of this, I've decided to leave this as an unbreedable species.
  
  
  
• 
  
  
  
  
  
  Not Fully Evolved Legendaries
  These species remain unchanged, and are incapable of breeding. They're considered baby species, and thus are too immature to breed. Breed their evolved forms to obtain eggs of these species.
  
  
  
• 
  
  
  
  
  
  
  
  Fused Legendaries
  The fused forms of Kyurem (Black, White), Necrozma (Dusk Mane, Dawn Wings, Ultra), and Calyrex (Ice Rider, Shadow Rider) cannot breed. You must revert them to their base forms before they can be bred.
  
  
  
• 
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  Paradox Pokemon
  These Pokemon cannot be bred. For the Ancient Paradox species, this is due to them being so ancient that their biology simply doesn't match up with any modern species, despite having distant relatives in the modern day. For the Future Paradox species, this is due to them being fully robotic, and thus having no biological components to allow them to breed at all. However, you may still create new Paradox Pokemon through a new mechanic introduced in this plugin called Paradox Engineering, which functions similarly to breeding, but without actually hatching these Pokemon from eggs.
  
  A full guide on Paradox Engineering is outlined below:
  
  Spoiler:

  Paradox Engineering functions identically to breeding, except instead of going to the Day Care couple to produce an Egg, you go to a Paradox Engineer to have them create a Paradox species for you.
  
  

  

  
  
  There are two different types of Paradox Engineer. Both types of Engineers work the same way.
  
  
  

  • Genetic Engineer
    A scientist focused on the Ancient Paradox species. They will Genetically Engineer one of these ancient Pokemon for you if you provide them with samples of modern-day genetic relatives to these paradox Pokemon that they can use to model their work on.
    
    
  • Cybernetic Engineer
    A scientist focused on the Future Paradox species. They will Cybernetically Engineer one of these futuristic Pokemon for you if you provide them with samples of modern-day species that these paradox Pokemon are based on, to act as a blueprint on how to build them.

  
  
  Engineering Requirements
  First, their services will not be unlocked until you acquire a Booster Energy item. Once you do, the Engineer will recognize it and tell you that if they use this as a power source, they'll be able to engineer a paradox species for you. You will need 1 Booster Energy for each Paradox species you want to produce. This works as the "cost" for Engineering a Pokemon, instead of paying with money to keep your Pokemon in a Day Care to produce Eggs. If you bring them a Booster Energy, you'll next need to bring them two Pokemon for them to begin the engineering process.
  
  

  

  
  
  
  

  • First Pokemon
    This Pokemon determines the species of what Paradox Pokemon is produced. This Pokemon is basically considered the "mother", if we are to translate this to breeding terms. However, unlike breeding, the gender of this first Pokemon does not matter. Even if the Pokemon is male, the Paradox Pokemon that is produced will always have their species decided by this first Pokemon you select. Also unlike breeding, only CERTAIN species can be selected. A Pokemon like Pikachu, who has no Paradox species that are based on it, is ineligible and cannot be selected.
    
    However, a Pokemon like Volcarona would be eligible, since it does have both the Slither Wing and Iron Moth Paradox species who are based on it. Note that even in this case, Larvesta would not be eligible, despite being in the same family as Volcarona. ONLY the species that have a specific Paradox species based on it is eligible. The one exception to this is Gardevoir and Gallade, since Iron Valiant is based on a combo of both of them. So either species can be used to create a new Iron Valiant.
    
    Also note that the type of Engineer you are speaking to changes which list of species are eligible. If you are speaking to a Genetic Engineer, then only species related to Ancient Paradox species are eligible. If you are speaking to a Cybernetic Engineer, then only species related to Future Paradox species are eligible.
    
    
  • Second Pokemon
    This Pokemon basically acts as the "father" of the pair, if we are to translate this to breeding terms. Unlike the first selected Pokemon, this second Pokemon doesn't need to be related to any Paradox species at all. However, all of the traditional breeding compatibility rules apply to this second Pokemon. It needs to be within a compatible Egg Group to the first selected Pokemon, as well as have the opposite gender of the first selected Pokemon (or Ditto). If this second Pokemon is unable to breed for whatever reason, it is also not eligible.
    
    This Pokemon basically acts as the catalyst for the Engineering process, and provides some variance for the Engineer. This allows them to use this second Pokemon as a backup reference source when they come across gaps in their knowledge about how to sequence the genes or design the AI of the Ancient or Future Paradox species, respectively. In gameplay terms, this basically means IV inheritance, Egg Moves, and all the other goodies that come from breeding.

  
  Receiving Your Paradox Pokemon
  Once two compatible Pokemon samples have been selected, and a Booster Energy has been provided, you're all set. Next, the Engineer will tell you they will need some time to complete their work, and to come back later. The Engineer will not keep your selected Pokemon, so they will still be with you during this time. In order to receive your new Paradox Pokemon from the Engineer, you will need to start walking. The amount of steps required for the Engineer to finish his work is equal to the number of Egg Steps that particular species would require if it was traditionally bred and hatched from an Egg.
  
  After the appropriate number of steps, you may return to the Engineer to receive your new Paradox Pokemon. It will be at level 1 when obtained, and pretty much be identical to what you would have received if you had been able to breed the Pokemon normally. The only difference, of course, is that it doesn't come from an Egg, so its "met" text will obviously be different. It will also display the location as "Paradox Engineer" instead of "Day-Care Couple".
  
  

  

  
  
  Note that it's totally possible to have multiple different Engineers designing a Paradox Pokemon for you at the same time. But any steps that you take can only be put towards a single Paradox Pokemon at a time. So if you speak to one Engineer, all of the steps you just took since the last time you spoke to an Engineer will be put towards completing that Engineer's Pokemon, and no progress will be made towards any of the other Engineer's Pokemon.
  
  Setting up a Paradox Engineer Event
  To set up a Paradox Engineer in your game, you simply have to enter the following script in an event:
  

  pbParadoxEngineer(paradox_type, gender)

  The first argument, "paradox_type", requires you to enter either :ancient or :future. This will determine whether this is a Genetic Engineer that will create Ancient Paradox Pokemon for you, or a Cybernetic Engineer who will create Future Paradox Pokemon for you. If omitted, this will default to a Genetic Engineer.
  
  The second argument, "gender", refers to the gender of the actual NPC who will be speaking when you talk to them. This will change the color of their text in dialogue boxes. When set to 0, the NPC will be considered male, and thus have blue text. If set to 1, the NPC will be considered female, and thus have red text. If omitted or set to -1, the NPC will be considered genderless and have normal black text.
  
  In addition, there is also a third argument you may enter if you wish. If your game does not feature the Booster Energy item, or if you wish to have another item set as the cost of engineering a Paradox Pokemon, then you may simply set the ID of that item as the third argument in this method. If omitted or left as nil, then the item will default to Booster Energy as it normally is.

Spoiler:

 

[Lucidious89]

Minor Update (v1.0.1)

• Updated the Pokemon PBS data to now include breeding data for Gen 9 Legendaries: Ting-Lu, Chien-Pao, Wo-Chien, and Chi-Yu.
• Removed Magearna from being a breedable species, as it really doesn't make any sense for a literal robot to produce Eggs in any way.
• Refined the Egg Move lists for all species; condensing them, and removing instances of all moves that appear as TM's as of Gen 9.
• Updated the PBS data for all relevant items added by this plugin to now utilize the PortionName and PortionNamePlural properties, to allow for compatibility with the Improved Item Text plugin.
• Changed any item text displays utilized by the plugin to now display portion name text wherever appropriate.
• Added the Paradox Engineering mechanic for all Paradox species added in Gen 9. Details of the mechanic can be viewed below.

Paradox Pokemon

Spoiler:

Gen 9 has added a slew of new species known as "Paradox Pokemon" that are functionally equivalent to Legendaries in the way Ultra Beasts were. Because of this, I've decided to include them as part of this plugin. However, Paradox Pokemon don't really make sense as being breedable (particularly the Future Paradox species), so I haven't simply made them breedable in the traditional sense. Instead, I created a brand new mechanic called "Paradox Engineering".

Paradox Engineering
Paradox Engineering functions identically to breeding, except instead of going to the Day Care couple to produce an Egg, you go to a Paradox Engineer to have them create a Paradox species for you.

There are two different types of Paradox Engineer. Both types of Engineers work the same way.

• Genetic Engineer
  A scientist focused on the Ancient Paradox species. They will Genetically Engineer one of these ancient Pokemon for you if you provide them with samples of modern-day genetic relatives to these paradox Pokemon that they can use to model their work on.
  
  
• Cybernetic Engineer
  A scientist focused on the Future Paradox species. They will Cybernetically Engineer one of these futuristic Pokemon for you if you provide them with samples of modern-day species that these paradox Pokemon are based on, to act as a blueprint on how to build them.

Engineering Requirements
First, their services will not be unlocked until you acquire a Booster Energy item. Once you do, the Engineer will recognize it and tell you that if they use this as a power source, they'll be able to engineer a paradox species for you. You will need 1 Booster Energy for each Paradox species you want to produce. This works as the "cost" for Engineering a Pokemon, instead of paying with money to keep your Pokemon in a Day Care to produce Eggs. If you bring them a Booster Energy, you'll next need to bring them two Pokemon for them to begin the engineering process.

• First Pokemon
  This Pokemon determines the species of what Paradox Pokemon is produced. This Pokemon is basically considered the "mother", if we are to translate this to breeding terms. However, unlike breeding, the gender of this first Pokemon does not matter. Even if the Pokemon is male, the Paradox Pokemon that is produced will always have their species decided by this first Pokemon you select. Also unlike breeding, only CERTAIN species can be selected. A Pokemon like Pikachu, who has no Paradox species that are based on it, is ineligible and cannot be selected.
  
  However, a Pokemon like Volcarona would be eligible, since it does have both the Slither Wing and Iron Moth Paradox species who are based on it. Note that even in this case, Larvesta would not be eligible, despite being in the same family as Volcarona. ONLY the species that have a specific Paradox species based on it is eligible. The one exception to this is Gardevoir and Gallade, since Iron Valiant is based on a combo of both of them. So either species can be used to create a new Iron Valiant.
  
  Also note that the type of Engineer you are speaking to changes which list of species are eligible. If you are speaking to a Genetic Engineer, then only species related to Ancient Paradox species are eligible. If you are speaking to a Cybernetic Engineer, then only species related to Future Paradox species are eligible.
  
  
• Second Pokemon
  This Pokemon basically acts as the "father" of the pair, if we are to translate this to breeding terms. Unlike the first selected Pokemon, this second Pokemon doesn't need to be related to any Paradox species at all. However, all of the traditional breeding compatibility rules apply to this second Pokemon. It needs to be within a compatible Egg Group to the first selected Pokemon, as well as have the opposite gender of the first selected Pokemon (or Ditto). If this second Pokemon is unable to breed for whatever reason, it is also not eligible.
  
  This Pokemon basically acts as the catalyst for the Engineering process, and provides some variance for the Engineer. This allows them to use this second Pokemon as a backup reference source when they come across gaps in their knowledge about how to sequence the genes or design the AI of the Ancient or Future Paradox species, respectively. In gameplay terms, this basically means IV inheritance, Egg Moves, and all the other goodies that come from breeding.

Receiving Your Paradox Pokemon
Once two compatible Pokemon samples have been selected, and a Booster Energy has been provided, you're all set. Next, the Engineer will tell you they will need some time to complete their work, and to come back later. The Engineer will not keep your selected Pokemon, so they will still be with you during this time. In order to receive your new Paradox Pokemon from the Engineer, you will need to start walking. The amount of steps required for the Engineer to finish his work is equal to the number of Egg Steps that particular species would require if it was traditionally bred and hatched from an Egg.

After the appropriate number of steps, you may return to the Engineer to receive your new Paradox Pokemon. It will be at level 1 when obtained, and pretty much be identical to what you would have received if you had been able to breed the Pokemon normally. The only difference, of course, is that it doesn't come from an Egg, so its "met" text will obviously be different. It will also display the location as "Paradox Engineer" instead of "Day-Care Couple".

Note that it's totally possible to have multiple different Engineers designing a Paradox Pokemon for you at the same time. But any steps that you take can only be put towards a single Paradox Pokemon at a time. So if you speak to one Engineer, all of the steps you just took since the last time you spoke to an Engineer will be put towards completing that Engineer's Pokemon, and no progress will be made towards any of the other Engineer's Pokemon.

Setting up a Paradox Engineer Event
To set up a Paradox Engineer in your game, you simply have to enter the following script in an event:

pbParadoxEngineer(paradox_type, gender)

The first argument, "paradox_type", requires you to enter either :ancient or :future. This will determine whether this is a Genetic Engineer that will create Ancient Paradox Pokemon for you, or a Cybernetic Engineer who will create Future Paradox Pokemon for you. If omitted, this will default to a Genetic Engineer.

The second argument, "gender", refers to the gender of the actual NPC who will be speaking when you talk to them. This will change the color of their text in dialogue boxes. When set to 0, the NPC will be considered male, and thus have blue text. If set to 1, the NPC will be considered female, and thus have red text. If omitted or set to -1, the NPC will be considered genderless and have normal black text.

In addition, there is also a third argument you may enter if you wish. If your game does not feature the Booster Energy item, or if you wish to have another item set as the cost of engineering a Paradox Pokemon, then you may simply set the ID of that item as the third argument in this method. If omitted or left as nil, then the item will default to Booster Energy as it normally is.

 

[Lucidious89]

Minor Update (v1.0.2)

• Added Walking Wake and Iron Leaves to the list of Paradox species that can be created through Paradox Engineering.
• Added Egg Moves for all Paradox species.

 

[Lucidious89]

Minor Update (v1.0.3)
**IMPORTANT** This update requires v1.2.5 of Essentials Deluxe to be installed. That update requires that you start a new game. **IMPORTANT**

• The following statistics are now tracked by the game, and can be accessed with the following scripts:
  • $stats.legendary_eggs_hatched: Tracks the total number of times the player hatched a Legendary Pokemon from an Egg.
  • $stats.paradox_pokemon_engineered: Tracks the total number of times the player received a Paradox Pokemon from a Paradox Engineer.

 

[Lucidious89]

ATTENTION! Final Version!
With the release of Essentials v21, the current version of this plugin (v1.0.3) will be the final version of Legendary Breeding for v20.1. Going forward I will instead be fully focused on v21, so I will no longer be updating or supporting this plugin. I intend to take a break before I even start thinking about how or when I'm going to start working on a v21 iteration of the plugin, so don't ask me about a time frame for release. I will keep this plugin available in the meantime. But this iteration of the plugin will eventually be removed once a v21 successor is released and takes its place. I will give fair warning before this happens, so don't panic.

See you all in v21!