View source for SOLDIER.DAT

= General Notes =
SOLDIER.DAT has a fixed structure of 250 entries of 68 bytes each. (Only a maximum of 250 soldiers can be had.) Thus it is always 17,000 bytes long (250x68).

In several places it uses Intel little-endian "Words". These are two bytes values with the low byte first, high byte second. Thus they can count over 255 (to 65,536). Sometimes they are "signed" however (8000h, when the highest bit is set), which makes the maximum positive value 32,767. It's of no concern in an ordinary game, but may be to hackers. "Signed" is noted below where applicable.

Values are presented according to byte count (1 to 68) followed by the equivalent hex offset (00 to 43) in <b>bold</b>, followed by the normal (non-hacked) range of values in <i>italics</i>. Most fields can be hacked up to FF, but sometimes it can make for weirdness!

= Structure =
<b>1-2 / 00-01</b> <i>(0-5, FFFF)</i>: Word set to Rank or FFFF if soldier is dead (or slot not yet used). These values are actually pointers within a text file, so if you change it to 7 it will say "SPACE AVAILABLE" as your rank. Strange stuff. Ranks are:

 0 Recruit
 1 Squaddie
 2 Sargeant (SGT)
 3 Captain (CPT)
 4 Colonel (COL)
 5 Commander (CDR)
 6 Units in Entrance
 7 Units in Target Exit
<b>3 / 02</b> <i>(varies, FF)</i>: Base the soldier is at, using reference numbers from LOC.DAT. First base is always 0 (first entry in LOC.DAT). Value of FF means the soldier is being transferred.

<b>5-6 / 04-05</b> <i>(varies, FFFF)</i>: Craft soldier is assigned to, using values from LOC.DAT. FFFF means not assigned to a craft.

<b>7-8 / 06-07</b> <i>(FFFF)</i>: Unknown. Presumed Word. Only ever seen to be FFFF.

<b>9-10 / 08-09</b> <i>(0+)</i>: Number of missions. Signed Word.

<b>11-12 / 0A-0B</b> <i>(0+)</i>: Number of kills. Signed Word.

<b>13-14 / 0C-0D</b> <i>(0+)</i>: Wound recovery days. Signed Word.

<b>15-16 / 0E-0F</b> <i>(20+)</i>: Death Penalty (morale hit if this guy dies). Presumably a signed Word. Is equal to 20 + Missions + Rank Bonus, as follows:

  0  Recruit
  0? Squaddie (not yet tested)
  1  SGT
  3  CPT
  6  COL
 10  CDR

Note: A test of hex-editing Missions and performing a combat (while not touching this field) did not cause this field to reflect the edited Missions value. This field simply added 1, as it normally would. So it doesn't appear to be <i>computed</i> from Missions; instead, both Missions and this field have a 1 added at the end of each mission. Presumably then, directly editing Rank would likewise not cause this to change.

<b>17-37 / 10-24</b> <i>(Text)</i>: Name, 21 characters long. Note that players can enter almost any keyboard character (unlike in Windows programs) because they are directly stored here instead of going through any Windows objects. Also FWIW, the 'ends' of player names are still kept here, if a new soldier in a slot has a shorter name than the previous soldier. The end of the current name is denoted by a null character (ASCII 00).

<b>38-41 / 25-28</b> <i>(0)</i>: Unknown. Four bytes that have only ever been seen to be 0, 0, 0, 0. Two unused Words?

<b>42 / 29</b> <i>(varies)</i>: Always 0 except for <i>existing</i> soldiers being transferred, in which case it equals the LOC.DAT value for destination base. <i>New</i> hirees on their way to a base will also have this set to 0, so if Byte 3 is set to FF and this byte is 0, you can't tell (from these two bytes alone) if it's an existing soldier going to your first base (LOC.DAT=0), or a new recruit going to any base. But the game knows where they're going, presumably via TRANSFER.DAT.

<b>43 / 2A</b> <i>(50-60)</i>: Initial TUs.

<b>44 / 2B</b> <i>(25-40)</i>: Initial Health.

<b>45 / 2C</b> <i>(40-70)</i>: Initial Stamina.

<b>46 / 2D</b> <i>(30-60)</i>: Initial Reaction.

<b>47 / 2E</b> <i>(20-40)</i>: Initial Strength.

<b>48 / 2F</b> <i>(40-70)</i>: Initial Firing Accuracy.

<b>49 / 30</b> <i>(50-80)</i>: Initial Throwing Accuracy.

<b>50 / 31</b> <i>(20-40)</i>: Initial Melee / Close Combat Accuracy. See Note 1.

<b>51 / 32</b> <i>(0-100)</i>: Psi Strength.

<b>53 / 34</b> <i>(5-10)</i>: Initial Bravery. Computed as 110-(10*ThisByte). E.g. if ThisByte=9, Bravery=20. So the lower this byte is, the better your Bravery is. Initial Bravery can be 10-60. Bravery always works in units of 10.

<b>52 / 33</b> <i>(0-100+)</i>: Current Psi Skill. 0 = has not yet had any Psi Lab training.

<b>54 / 35</b> <i>(0-30+)</i>: Increase in TUs. (Max total TUs possible (initial+increase) is approximately 80. See Note 2.)

<b>55 / 36</b> <i>(0-35+)</i>: Increase in Health. (Max total approx. 60)

<b>56 / 37</b> <i>(0-60+)</i>: Increase in Stamina. (Max total approx. 100)

<b>57 / 38</b> <i>(0-60+)</i>: Increase in Reaction. (Max total approx. 90)

<b>58 / 39</b> <i>(0-50+)</i>: Increase in Strength. (Max total approx. 70). Note that more than 64 here will make you unable to throw anything. Possibly the [[Throwing_Accuracy#Throwing_Distance|throwing distance]] function only checks the lowest 6(?) bits of current strength, or a high value otherwise pushes the XCOM equation out of allowable bounds.

<b>59 / 3A</b> <i>(0-80+)</i>: Increase in Firing Accuracy. (Max total approx. 120)

<b>60 / 3B</b> <i>(0-70?)</i>: Increase in  Throwing Accuracy. (Max total approx. 120?)

<b>61 / 3C</b> <i>(0-?)</i>: Increase in Melee/Close Combat Accuracy. See Note 1.

<b>62 / 3D</b> <i>(0-1?)</i>: Increase in Bravery (multiply by 10).

<b>63 / 3E</b> <i>(0-3)</i>: Armor. 0=None, 1=Personal Armor, 2=Power Armor, 3=Flying Suit, 4=Sectoid 5=Snakeman, 6=Ethereal, 7=Muton, 8=Floater, 9=Celatid, 10=Silacoid, 11=Chryssalid. (the rest is just parts of the big units and civilians)NOTE: theese are not real aliens... just skins... mor research must be taken about skinds... like the appearance... or gender to find real aliens

<b>64 / 3F</b> <i>(0-24?)</i>: Most-recent month's Psi Lab training increase. Largest values for newly trained (16-24).

<b>65 / 40</b> <i>(0,1)</i>: In Psi Lab training.

<b>66 / 41</b> <i>(0,1)</i>: Promotion flag (as of most recent combat). Reset as of next combat.

<b>67 / 42</b> <i>(0,1)</i>: 0=Male, 1=Female, 2=???.

<b>68 / 43</b> <i>(0-3)</i>: Appearance (for loadout, no armor): 0=blonde, 1=brown hair, 2=Oriental, 3=African, 4=???.

= Notes =

1) Melee or Close Combat Accuracy is a somewhat abandoned skill. It does not appear in display screens, but Byte 61 <b>does</b> increase when the stun rod is used. Also, secondary skills will increase when you do this, as they do for other primary skills. Given their placement in this file, then, it is presumed that this is a third 'accuracy' skill related to stun-rod use, with Byte 50 being the initial value and Byte 61 being the increase.

2) The possible values for skill increases (in a non-hacked game) depend both on the cap for each skill and on each soldiers' initial value. Thus the max possible value shown in the 'increase' range is for soldiers who started with the minimum initial skill.

3) Be careful of making total skill value (initial + increase) greater than 160 (A0h). This will make your skill bar wrap around the screen.

4) As can be seen, Armor is the only thing that 'stays with' a soldier. Yes, it's lost if you fire someone wearing it!

5) This work was done by [http://www.stonepool.com/xcom/hacking/soldier.html hatfarm] and [[User:MikeTheRed|MikeTheRed]]. More info welcomed!

= For More Information =

*Information on individual skills can be seen at [[Soldiers (UFO Defense) | Soldiers]].
*For more information on increasing skills, see [[Experience]].
*For more information on starting soldier stats, see [[Raw_recruit_statistical_likelihood|Raw Recruit Statistical Likelihood]].

= Addendum: Hex Workshop Structure Library =

The following can be used to make an XCOMUFO.hsl file that will work with Hex Workshop (v4.23) available from [http://www.bpsoft.com www.BPSoft.com]. This allows one to overlay a structure while viewing/editing SOLDIER.DAT and work in a more organized fashion. Tip: Set the data view window to 34 bytes wide, and each SOLDIER record will take exactly two display lines. (It won't let you set it to higher than 64, unfortunately.)

 /***********************************************************************************
  * XCOMUFO.hsl - Structure definitions for XCOM UFO DEFENSE v1.4
  *    This structure def last edited Sept. 16, 2005
  *    Mike Fay mikestar@speedfactory.net
  *    MikeTheRed on www.xcomufo.com forums
  *    Also see the SOLDIER.DAT wiki at www.ufopaedia.org/index.php?title=SOLDIER.DAT
  ***********************************************************************************
  * Revision History:
  *  09/26/05 - MF - Original
  */
 
 #include "standard-types.hsl"
 
 // SOLDIER.DAT
 struct SOLDIER_DAT 
 {
    WORD Rank ;
    WORD BaseOrTransfer ;
    WORD Craft ;
    WORD UnknownFFFF;
    WORD Missions ;
    WORD Kills ;
    WORD WoundDays ;
    WORD DeathPenalty ;
    CHAR Name[21] ;
    WORD UnknownUnused1 ;
    WORD UnknownUnused2 ;
    UBYTE TransferBase ;
    UBYTE TUs_Init ;
    UBYTE Health_Init ;
    UBYTE Stam_Init ;
    UBYTE Rxns_Init ;
    UBYTE Str_Init ;
    UBYTE FAcc_Init ;
    UBYTE TAcc_Init ;
    UBYTE MAcc_Init ;
    UBYTE Psi_Str ;
    UBYTE Psi_Skill ;
    UBYTE Brave_Init ;
    UBYTE TUs_Inc ;
    UBYTE Health_Inc ;
    UBYTE Stam_Inc ;
    UBYTE Rxns_Inc ;
    UBYTE Str_Inc ;
    UBYTE FAcc_Inc ;
    UBYTE TAcc_Inc ;
    UBYTE MAcc_Inc ;
    UBYTE Brave_Inc ;
    UBYTE Armor ;
    UBYTE PsiLab_Inc ;
    UBYTE PsiLab_Flag ;
    UBYTE Promotion_Flag ;
    UBYTE Gender ;
    UBYTE Appearance ;
 } ;