Jump to content
  • How to Use the Batch Editor in PKHeX

    In this tutorial you will learn how to properly use the Batch Editor in PKHeX. The batch editor, when utilized fully and correctly, can be an extremely useful tool for fixing, and editing Pokemon.

     

    Please Note: The Batch Editor does NOT have an undo option and therefore all actions taken with the Batch Editor are FINAL

    unless you quit PKHeX without saving. As a result.

    MAKE SURE YOU HAVE BACKUPS OF YOUR SAVE BEFORE YOU EDIT IT WITH THE BATCH EDITOR.


     

    Section 1: Basic Fundamentals and operation of the Batch Editor

     

    The Batch editor works on the simple premise that all possible characteristics pertaining to a Pokemon, boil down to a set of numbers which correspond to certain values in the Pokemon games themselves. Because of this, changing, and editing Pokemon using the Batch Editor is like a mathematical statement, with if then, and true/false statements.

    The basic operators of the Batch Editor are:

    "." = Sets the desired value Equal to the value you input

    "=" = Narrows the editing of Pokemon down to the Pokemon which have the same value as your input value

    "!" = Narrows the editing of Pokemon down to the Pokemon which do not have the same value as your input value.

    As an example of how these operators are used, Once you select a variable you would like to change (OT Name, Pokemon Species, Pokemon Level, etc...) and the correct operator, click "Add". This will add your desired variable with your desired operator in the correct format. The next step is to create the formula in which the Batch Editor will run. 

    As an example of a possible combination for use in the Batch Editor, the following formula will change the OT trainer name on Pokemon with a specific OT to a specified OT trainer name, as well as give every Pokemon with that filter, a Master Ball to hold.

    image.png

     

    =OriginalTrainerName=PKHeX This line instructs the Batch Editor to narrow it's scope down to every Pokemon with the OT Trainer Name "PKHeX"
    .OriginalTrainerName=TEST This lines instructs the Batch Editor to set the OT Trainer Name for all of the previously filtered Pokemon to "TEST
    .HeldItem=1 This line instructs the Batch Editor to set the Held Item for all of the previously filtered Pokemon to a Master Ball - which Item Index number is 1.
       

    Some Special Tricks to use in the Batch Editor, Courtesy of @Kaphotics (Creator of PKHeX)

    1. The Batch Editor window references the PKM that is currently viewed in the editing tabs.
      1. If you select a property name, the Batch Editor will indicate whether or not the tabs PKM has that property.
      2. If the tabs PKM has that property, the Batch Editor will display the property's current value as well as the data type (number, text, etc).
    2. To Randomize a PID, use ".PID=$rand".
    3. To Randomize EncryptionConstant, use ".EncryptionConstant=$rand"
    4. To Randomize a value within a range, use ".Nature=$x,y" for an inclusive range of [x,y].
    5. To make a Pokémon Shiny: use ".PID=$shiny".
    6. To copy the Encryption Constant to the PID, use ".EncryptionConstant=PID"
    7. To delete a Pokémon, use ".Species=0"
    8. To set a date (Met / EggMet), use yyyyMMdd for the string.
      1. Example: ".MetDate=20160409" will set the Met Date to April 9th, 2016.
    9. Suggestions can be automatically applied for Moves, RelearnMoves, and Met_Location.
      1. Example: ".Moves=$suggest" will retrieve and apply suggested moves from the legality interpreter, same as if you clicked on the Moves groupbox in the tabs editor.
    10. Legality can be used as a filter. Use "=Legal=false" to only modify illegal Pokémon.
    11. A full up to date list is available by reading the Pokémon properties from the PKHeX source code

     

    Section 2: ID Numbers for Use with the Batch Editor

     

    This section will focus on the input values you can use in conjunction with the Batch Editor. The Batch Editor uses the in-game index values to set the desired properties to Pokemon. Because of this you will need to use said index numbers instead of relying on the standard text based input present in PKHeX. As an example, to set the species of a Pokemon using the Batch Editor, you must use the equation

    .Species=150

    Not .Species=Mewtwo

    Below are many of the common variables you may want to use, along with the possible values to use with those variables.

    Please Note: Some variables (like location, items etc...) have different ID numbers for different generations. Please ensure that you are using the correct ID numbers that correspond to the generation of the game you are editing.

     

    Ability:

      Reveal hidden contents

     

    AbilityNumber:

      Reveal hidden contents

     

    Form:

      Reveal hidden contents

     

    Ball:

      Reveal hidden contents

     

    Box:

      Reveal hidden contents

     

    CanGigantamax

      Reveal hidden contents

     

    ConsoleRegion:

      Reveal hidden contents

     

    Country:

      Reveal hidden contents

     

    CurrentFriendship:

      Reveal hidden contents

     

    CurrentLevel:

      Reveal hidden contents

     

    DynamaxLevel:

      Reveal hidden contents

     

    TeraTypeOriginal and TeraTypeOverride:

      Reveal hidden contents

     

    EggLocation:

      Reveal hidden contents

     

    EggMetDate:

      Reveal hidden contents

     

    EV_ATK, EV_DEF, EV_HP, EV_SPA, EV_SPD, EV_SPE:

      Reveal hidden contents

     

    FatefulEncounter:

      Reveal hidden contents

     

    Gender:

      Reveal hidden contents

     

    HeldItem:

      Reveal hidden contents

     

    HPType:

      Reveal hidden contents

     

    IsEgg:

      Reveal hidden contents

     

    IsNicknamed:

      Reveal hidden contents

     

    IV_ATK, IV_DEF, IV_HP, IV_SPA, IV_SPD, IV_SPE:

      Reveal hidden contents

     

    Language:

      Reveal hidden contents

     

    Legal:

      Reveal hidden contents

     

    MarkCircle, MarkDiamond, MarkHeart, MarkSquare, MarkStar, MarkTriangle:

      Reveal hidden contents

     

    MetLevel:

      Reveal hidden contents

     

    MetLocation:

      Reveal hidden contents

     

    MetDate:

      Reveal hidden contents

     

    Move1, Move2, Move3, Move4:

      Reveal hidden contents

     

    Move1_PPUps, Move2_PPUps, Move3_PPUps, Move4_PPUps:

      Reveal hidden contents

     

    Nature:

      Reveal hidden contents

     

    Nickname:

      Reveal hidden contents

     

    OriginalTrainerGender:

      Reveal hidden contents

     

    OriginalTrainerName:

      Reveal hidden contents

     

    PID:

      Reveal hidden contents

     

    RelearnMove1, RelearnMove2, RelearnMove3, RelearnMove4:

      Reveal hidden contents

     

    Ribbons

      Reveal hidden contents

     

    ShinyLeaf (Gen 4 HG/SS Only)

      Reveal hidden contents

     

    SID16 or TrainerSID7:

      Reveal hidden contents

     

    TID16 or TrainerTID7:

      Reveal hidden contents

     

    Slot:

      Reveal hidden contents

     

    Species:

      Reveal hidden contents

     

    Stat_ATK, Stat_DEF, Stat_HP, Stat_SPA, Stat_SPD, Stat_SPE:

      Reveal hidden contents

     

    Version:

      Reveal hidden contents

     

    JUST IN CASE ANY OF THE VALUES ABOVE ARE NOT UPDATED:
    You can use Batch Editor to also view the particular values you want.
      Reveal hidden contents

    Special Thanks to @theSLAYER for help with making and researching this guide with me
    • Like 5



    User Feedback

    Recommended Comments



      On 6/14/2024 at 2:09 PM, lxy4251326 said:

    how to use 

    .TrashCharCountTrainer=
    .TrashCharCountNickname=

    Expand  

    Those properties can only be used as filters; you cannot set to them because there is no setter in the source code. They're constant values based on the PKM class type.

    If you are looking to clear all trash, you can do it like so (filter for a specific pattern, clear and reapply):

    =OriginalTrainerName=Kurt
    .OriginalTrainerTrash=$[]00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00
    .OriginalTrainerName=Kurt
    =IsNicknamed=false
    .NicknameTrash=$[]00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00,00
    .IsNicknamed=false

     

    Share this comment


    Link to comment
    Share on other sites

    How can I modify all boxes (or multiple boxes) at once? 

    Share this comment


    Link to comment
    Share on other sites

      On 7/14/2024 at 4:45 PM, PLAFiles said:

    How can I modify all boxes (or multiple boxes) at once? 

    Expand  

    Unless you target specific mons with filter queries, the batch editor already target all the mons in all the boxes.

    Share this comment


    Link to comment
    Share on other sites

      On 7/15/2024 at 10:19 AM, SkyLink98 said:

    Unless you target specific mons with filter queries, the batch editor already target all the mons in all the boxes.

    Expand  

    Wait, what? Anytime I've done edits, I do, for example:

    =Box=1
    .OriginalTrainerName=
    .TID=
    .SID=

    And then I quickly backspace the "1," make it a "2," then press Tab or whatever to submit it and do that for every box. What I posted above does all Pokémon in one box, but I want all boxes.

    Share this comment


    Link to comment
    Share on other sites

      On 7/16/2024 at 10:27 PM, PLAFiles said:

    Wait, what? Anytime I've done edits, I do, for example:

    =Box=1
    .OriginalTrainerName=
    .TID=
    .SID=

    And then I quickly backspace the "1," make it a "2," then press Tab or whatever to submit it and do that for every box. What I posted above does all Pokémon in one box, but I want all boxes.

    Expand  

    =Box=1, that's a filter that targets only the first box. Remove it and your script will target all the mons.

    Share this comment


    Link to comment
    Share on other sites




    Create an account or sign in to comment

    You need to be a member in order to leave a comment

    Create an account

    Sign up for a new account in our community. It's easy!

    Register a new account

    Sign in

    Already have an account? Sign in here.

    Sign In Now

×
×
  • Create New...