Add createmon Script Cmd, Support for 2v1Wild Battles

[ghoulslash]

NOTE this requires a clean make to update all instances of givemon

Adds support for setting up 2v1 wild battles. It does this by adding 2 new script commands:

1. createmon - this is the same setup as givemon but allows you to create the mon at a given side (0 for player, 1 for opponent) and slot (0-5). ScriptGiveMonParameterized has also been updated to handle a given slot/side. If slot = PARTY_SIZE, it will give the mon as normal
2. setwilddoubleflag just sets sIsScriptedWildDouble, so in the example script below we can initiate a battle where the player has 2 mons and there is only 1 opponent

Example script:

    givemon SPECIES_TYRANITAR, 50
    givemon SPECIES_METAGROSS, 50
    
    createmon 1, 0, SPECIES_SALAMENCE, 50, ITEM_KINGS_ROCK, 0, NATURE_HARDY, 0, MON_MALE
    setwilddoubleflag
    dowildbattle

But we could also create multiple enemy mons to set up a more advanced 2v2 wild battle

[AlexOn1ine]

Is it correct that both script commands are named ScrCmd_createmon?

Also is there a way to combine both scripts since most of it is the same?

[ghoulslash]

Both just call the same function which I edited to handle the addition inputs.

As far as using the same macros.. I don't think so since most are optional, but I could be wrong

[AlexOn1ine]

Both just call the same function which I edited to handle the addition inputs.

Right.

Though for some reason the CI fails for tests without having run any tests

[ghoulslash]

Both just call the same function which I edited to handle the addition inputs.

Right.

Though for some reason the CI fails for tests without having run any tests

yeah I don't get that... its saying PARTY_SIZE is undefined, but global.h is included which includes constants/global.h where that is defined...

[ghoulslash]

I've tried including and redefining PARTY_SIZE in a few places with no luck - I'm thinking of just changing .byte PARTY_SIZE to .byte 6 with a comment about PARTY_SIZE next to it to resolve the issue if that is acceptable

[AlexOn1ine]

I've tried including and redefining PARTY_SIZE in a few places with no luck - I'm thinking of just changing .byte PARTY_SIZE to .byte 6 with a comment about PARTY_SIZE next to it to resolve the issue if that is acceptable

I would do that unless someone has an idea what's going on.

[ghoulslash]

ready for review

[AlexOn1ine]

The givemon macro now replaces the first slot mon in the party when you receive it.

Test to verify it:

TEST("givemon twice [simple]")
{
    ZeroPlayerPartyMons();

    RUN_OVERWORLD_SCRIPT(
        givemon SPECIES_WOBBUFFET, 100;
        givemon SPECIES_WYNAUT, 1;
    );

    EXPECT_EQ(GetMonData(&gPlayerParty[0], MON_DATA_SPECIES), SPECIES_WOBBUFFET);
    EXPECT_EQ(GetMonData(&gPlayerParty[0], MON_DATA_LEVEL), 100);

    EXPECT_EQ(GetMonData(&gPlayerParty[1], MON_DATA_SPECIES), SPECIES_WYNAUT);
    EXPECT_EQ(GetMonData(&gPlayerParty[1], MON_DATA_LEVEL), 10);
}

Could you also add it to the PR once fixed? Also could you make tests for createmon the same way they are done for givemon?

You can just check the enemy party. Here is the simple one:

TEST("createmon [simple]")
{
    ZeroPlayerPartyMons();

    RUN_OVERWORLD_SCRIPT(
        createmon 1, 0, SPECIES_WOBBUFFET, 100;
        createmon 1, 1, SPECIES_WYNAUT, 10;
    );

    EXPECT_EQ(GetMonData(&gEnemyParty[0], MON_DATA_SPECIES), SPECIES_WOBBUFFET);
    EXPECT_EQ(GetMonData(&gEnemyParty[0], MON_DATA_LEVEL), 100);
    EXPECT_EQ(GetMonData(&gEnemyParty[1], MON_DATA_SPECIES), SPECIES_WYNAUT);
    EXPECT_EQ(GetMonData(&gEnemyParty[1], MON_DATA_LEVEL), 10);
}

The tests are in test/pokemon.c

[ghoulslash]

The givemon macro now replaces the first slot mon in the party when you receive it.

Test to verify it:

TEST("givemon twice [simple]")
{
    ZeroPlayerPartyMons();

    RUN_OVERWORLD_SCRIPT(
        givemon SPECIES_WOBBUFFET, 100;
        givemon SPECIES_WYNAUT, 1;
    );

    EXPECT_EQ(GetMonData(&gPlayerParty[0], MON_DATA_SPECIES), SPECIES_WOBBUFFET);
    EXPECT_EQ(GetMonData(&gPlayerParty[0], MON_DATA_LEVEL), 100);

    EXPECT_EQ(GetMonData(&gPlayerParty[1], MON_DATA_SPECIES), SPECIES_WYNAUT);
    EXPECT_EQ(GetMonData(&gPlayerParty[1], MON_DATA_LEVEL), 10);
}

Its working in game...

It looks like your test fails because your giving a level 1 Wynaut but checking that its level 10

Could you also add it to the PR once fixed? Also could you make tests for createmon the same way they are done for givemon?

Sure, just added

[AlexOn1ine]

That's weird. It doesn't work for me ingame. That's how I found it out.

givemon SPECIES_LATIOS, 100, nature=NATURE_HARDY

createmon.mp4

[AlexOn1ine]

Also just realized this supersedes setwildbattle. Should we get rid of it in this case?

[ghoulslash]

That's weird. It doesn't work for me ingame. That's how I found it out.

givemon SPECIES_LATIOS, 100, nature=NATURE_HARDY

createmon.mp4

weird... this is what I've tried and it worked

givemon SPECIES_TYRANITAR, 50
    givemon SPECIES_METAGROSS, 50, nature=NATURE_MODEST

You might have to make clean if you haven't previously?

[AlexOn1ine]

Also just realized this supersedes setwildbattle. Should we get rid of it in this case?

@ghoulslash what you think about this? We've retired the old givemon macro as well.

[AlexOn1ine]

That's weird. It doesn't work for me ingame. That's how I found it out.

givemon SPECIES_LATIOS, 100, nature=NATURE_HARDY

createmon.mp4

weird... this is what I've tried and it worked

givemon SPECIES_TYRANITAR, 50
    givemon SPECIES_METAGROSS, 50, nature=NATURE_MODEST

You might have to make clean if you haven't previously?

make clean worked but it is very odd. could you mentioned it in the description?

[ghoulslash]

Also just realized this supersedes setwildbattle. Should we get rid of it in this case?

@ghoulslash what you think about this? We've retired the old givemon macro as well.

not sure. On the one hand setwildbattle would not be needed, but I don't like the idea of current users needing to go back and update old scripts to handle the change. Because setwildbattle can set a single or double battle I don't think there's a way to make setwildbattle just call createmon, either. So I'm leaning towards keeping setwildbattle.
A bigger consideration is that setwildbattle calls ZeroEnemyPartyMons whereas createmon cannot

[AlexOn1ine]

Also just realized this supersedes setwildbattle. Should we get rid of it in this case?

@ghoulslash what you think about this? We've retired the old givemon macro as well.

not sure. On the one hand setwildbattle would not be needed, but I don't like the idea of current users needing to go back and update old scripts to handle the change. Because setwildbattle can set a single or double battle I don't think there's a way to make setwildbattle just call createmon, either. So I'm leaning towards keeping setwildbattle. A bigger consideration is that setwildbattle calls ZeroEnemyPartyMons whereas createmon cannot

that's fair