Difference between revisions of "Worms Armageddon mission file"

Revision as of 16:12, 18 September 2012

The Worms Armageddon mission file is the file format used to store missions. It contains many typos and spelling errors; so any typos in this page are more likely to be mistakes in the actual format than typos in the documentation.

Mission files in a disc installation of Worms Armageddon are located on the CD. Which map is used appears to be hard-coded (not usually the same one as the mission filename), as are names and descriptions. This makes making custom missions a bit of a pain. However, below is an almost-complete documentation on the file format. A few notes from Worms World Party are also mentioned due to its mission editor existing, but this documentation is NOT comprehensive for the WWP file format which has many additions and a few alterations (especially of unused or little-known options). In the future, WWP additions may be listed at the bottom of this page.

Mission Groups

All mission settings are organized under main groups according to their type. These groups always appear in the same order in official missions. (it is uncertain if the ordering matters)

Not all the of the groups are vital for the mission to work. The [CPUTeam#], [Event####], and [Sequence####] may have multiple instances in the file, and the group seems to be ignored if the number is zero so make sure it's positive.

Typos and many other errors appear to be silently ignored, which isn't great for manual debugging, especially since the file format is filled with them in the first place.

1. The [Mission] Group

This contains the overview of the mission itself. Not yet particularly well-documented on the whole.

2. The [Description] Group

This contains details about the description of the mission. Again, not at all well-documented.

3. The [Options] Group

This contains the bulk of the scheme options for the mission. It's pretty comprehensive, containing many features not in the normal scheme format. Many of the values work differently to in the standard scheme format, so read the value descriptions carefully. Most of these are documented well but it is unknown what the upper and lower limits are for many of them; value ranges acceptable in the WWP mission editor are included where it is not obvious.

4. The [Enviroment] Group

This contains information about the environment of the landscape. Once again, reasonably documented, but value limits are not known.

5. The [Teams] Group

Very small group describing the number of teams in the mission.

6. The [HumanTeam] Group

The group describing the human team.

7. The [CPUTeam#] Group

Any number of groups describing CPU teams. Presumably limited to five of these.

8. The [Events] Group

Definitely not required, this group.

9. The [Event####] Group

Events happen independently of each other after a certain number of turns. If more than one event exists for a given turn, they are executed in numerical order. Note that possibly due to a bug or possibly by design, events must appear in the order in which they occur - so if a turn 0 event appears after a turn 1 event, the turn 0 event will not be executed.

10. The [Sequence####] Group

Sequence groups are always executed in numerical order from the start of the mission, but sequences in a given turn are always executed after events (in case the first event is "pause executing sequence"). Some event IDs cause the sequence to pause execution until some condition is fulfilled. Note that it is only possible to have one sequence running at a time, unlike WWP where you can have at least two.

All options are mostly identical to ones in Event groups; the only difference is the way in which they are executed. Despite the Turn= parameter appearing in official missions, it does not work for sequences. To get a sequence to start after a certain turn, you will need to use a Pause Sequence Event and then a Resume Sequence event on the turn you want it to start.

Event types

Here are the possible values and their functions for the TypeOfEvent settings in events and sequences. Do bear in mind that some of them are only particularly useful in one or the other, but the types appear to be consistent between them which is nice.

Weapon Strings

The weapon settings in a mission may be configured individually for each team through use of the Ammo_ and Delay_ prefixes, followed by a weapon string and settings. For example, Ammo_Batrope=-1 would set a team's ninja rope supply to infinite, and Delay_Bazooka=2 would apply a 2 turn bazooka delay.

The following is a list of weapon strings. You always have an infinite supply of Skip go and Surrender, so supplying ammo is unnecessary. It is currently unknown if it is possible to add Aqua Sheep directly to the inventory (but they can be provided in weapon crates, which is the method used in the official missions) - it appears to be implemented with the AquaSheep string, but in rudimentary tests this has not worked.

You can also add the instant effect utilities to your inventory with the following weapon strings, which will correctly take effect for the opening turn only, regardless of how many ammo you give. The exception is Crate Spy, which will last for the entire mission, as expected.

• Damagex2
• CrateSpy
• DoubleTime
• CrateShower

Text_String_Index

The transition messages you get during missions are hardcoded into the game and are referred to via a number. The following table summarises which numbers refer to which messages (in English).

Notes:

• There is a typo in-game for messages number 22 and 42, they contain a carriage return arrow at the end.
• Strings 120 - 130 are the names of the CPU teams usable in missions.
• There may be other non-empty strings beyond 130, but they are unlikely to be useful for the purpose of being used during a mission.

PlaceWeapon_Contents

When placing a weapon or utility crate you need to refer to its contents by a number rather than a name. The following list indicates which number refers to which crate contents:

See also

• WA Mission Customization Guide