Document most of the Battle Hall logic

[VicSevenT]

This covers most of the battle hall-specific frontier script commands, including all the logic for picking the next opponent. The main chunk of logic left remaining for the Battle Hall is the communication code, which I am leaving until after #1179 is merged.

battle_hall_helpers.c contains some massive lists used to help generate the next opponent. One of these is a listing of frontier trainer classes, and I was able to generate this in frontierproc. The other two are related to the pokemon in pl_bsdpm.narc, which is still not unpacked. I hope to be able to unpack this and generate those lists to in the near future.

[lhearachel]

suggestion: I would like to annotate the arguments to script-commands with :req to denote that they are required. Otherwise, it's a pretty big foot-gun for an end-user. That can be a separate PR, but we should definitely do it.

I have a basic awk-script for this, if that interests you:

#!/usr/bin/env -vS awk -f

! /\.macro/ { print $0 }

/\.macro/ {
    for (i = 3; i <= NF; i++) {
        if ($i ~ /.*,/) {
            sub(/,/, ":req,", $i)
        } else {
            $i = $i ":req"
        }
    }

    print "    " $0
}

Stick this in a file, make it executable, and run it against the input file:

./annotate.awk asm/macros/frscrcmd.inc > asm/macros/frscrcmd.inc.new

Then you can check the output and replace the old file.

[VicSevenT]

Makes sense, but as you say, I think this should be in a separate PR.