Documentation of fl#add_kit_ee

## fl#add_kit_ee

This is an action function. On EE-type games, it complements ADD_KIT by patching the new 2DA files with information provided by the modder. It does nothing on game types other than BG: EE, BGII: EE and IWD: EE. For a usage example, refer to the "example" directory. This function requires WeiDU 237 or more recent.

This function will serve as a prototype for an eventual extension of `ADD_KIT`. You are welcome to use this forum to report bugs or submit requests for additions and changes.

#### Usage:

1. Copy the file fl#add_kit_ee.tpa into your mod folder.

2. `INCLUDE` the file in your TP2 file.

3. Use `ADD_KIT` as you normally would.

4. Launch the action function `fl#add_kit_ee` after `ADD_KIT`.

   Integer variables:

   - `biography` : optional : string reference
   - `fallen` : optional : 0 or 1
   - `briefdesc` : optional : string reference
   - `fallen_notice` : optional : string reference

   String variables:

   - `kit_name` : required : the internal name of your kit
   - `backstab` : optional : 2DA string
   - `clsrcreq` : optional : 2DA string
   - `clswpbon` : optional : 2DA string
   - `hpclass` : optional : 2DA string
   - `numwslot` : optional : 2DA string
   - `thiefskl` : optional : 2DA string
   - `traplimt` : optional : 2DA string
   - `clascolr` : optional : 2DA string
   - `clasiskl` : optional : 2DA string
   - `clasthac` : optional : 2DA string
   - `thiefscl` : optional : 2DA string
   - `sneakatt` : optional : 2DA string
   - `crippstr` : optional : 2DA string

   If no value is provided for one or more of the optional variables, the corresponding value of the parent class is copied and used for this kit.

   None of the 2DA strings should include the kit name. It will be included automatically as appropriate.

   The variables `biography`, `fallen`, `briefdesc` and `fallen_notice` are used in the file clastext.2da.

   If `hpclass` references a custom 2DA file, it needs to be copied into the game separately.

   The variables `backstab`, `thiefskl`, `traplimt`, `sneakatt` and `crippstr` should only be provided for thief kits and will be ignored for other classes.

#### Version history

v1.1.3:

- Update sodcltxt.2da on SoD games.

v1.1.2:

- Fix the platform check to be less needlessly discriminating. Notably, the function should now work on SoD.

v1.1.1:

- Perform more thorough checking of input data, for greater robustness.

v1.1.0:

- Add IWD: EE support.

v1.0.5:

- Add support for the IWD: EE 2DA files sneakatt and crippstr.
- Fix another compatibility issue with games lacking the expected columns.

v1.0.4:

- Fix compatibility issue with games lacking a FALLEN_NOTICE column.
- Fix a risk of variables from the calling environment aversely affecting the function.

v1.0.3:

- Do nothing on non-EE games.
- The check for whether the kit exists is more robust.

v1.0.2:

- Additional examples.
- Add `fallen` variable.
- Account for FALLEN_NOTICE in clastext.2da

v1.0.1:

- Fix a mistyped variable name.

v1.0.0: Initial release