Test.mediawiki

<div style="background:#ffdddd;">
'''DID YOU KNOW?'''

OpenXcom (and also OpenXcom Extended) have a ruleset syntax validation and auto-completion tool (a plugin for VSCode), which automatically finds and highlights all your syntax errors.

'''More info''': https://openxcom.org/forum/index.php/topic,6552.0.html

'''Give it a try!'''
</div>

A reference of the customizable values of everything in a [[Rulesets (OpenXcom)|ruleset]], according to the latest OpenXcom nightly.
* '''Last dev update''': 29th December 2025, by Meridian
* '''Synchronized with''': OpenXcom v1.0 (2025-12-07 nightly build) <span style="background:#ddffdd;">and OpenXcom Extended v8.5 (2025-12-14)</span>

<div style="background:#ddffdd;">
'''IMPORTANT''': The OpenXcom Extended (OXCE) ruleset is highlighted using '''light green background''', just like the one used in this disclaimer. Anything marked green does not work with OpenXcom (OXC).
</div>

Some guidelines:
* If a value is omitted from the ruleset, the default is used. You cannot omit ''required'' values.
* Text strings (eg. names) are represented by string IDs from the [[Translations (OpenXcom)|language files]]
* Numerical IDs (used for sprites, sounds, etc.) start at 0, not 1.
* Boolean (yes/no) values are represented by true/false.
* World coordinates are represented in degrees (see [[WORLD.DAT]]).
* Money amounts (prices, costs, etc.) are represented in dollars.
* All file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive.  In general, though, if it works on one operating system, it will work on all operating systems.
* Items are ordered as they come in the ruleset. To override this, you can specify a '''listOrder''' attribute. You can find the default listOrders in [[Ruleset List Order (OpenXcom)|Ruleset List Order]].
* <span style="background:#ddffdd;">The YAML parser ''yaml-cpp'' used by OXC and OXCE doesn't support the '''<<:''' operator (see https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/). OXCE therefore implemented its own support for the same/similar functionality. It allows you to copy YAML code using anchors and override some of the copied values. OXCE allows this for almost all types of rulesets, via the '''refNode''' attribute. Below is an example for creating a new Laser Sniper Rifle item from an existing Laser Rifle item:</span>

  items:
    - &STR_LASER_RIFLE           # Let's mark laser rifle info with an anchor
      type: STR_LASER_RIFLE
      size: 0.2
      costSell: 36900
      weight: 8
  #
  # a million other attributes...
  #
    - type: STR_LASER_SNIPER_RIFLE
      refNode: *STR_LASER_RIFLE  # First, let's copy everything from the STR_LASER_RIFLE anchor. Please note this is NOT inheritance, just a glorified copy-paste.
      bigSprite: xxx             # And now let's give it a new sprite,
      accuracyAimed: 160         # increase aimed shot accuracy
      tuAuto: 0                  # and disable auto shot.

* <span style="background:#ddffdd;"> OXCE allows changing how lists are overriden in sub-mods using YAML tags:</span>

  #base mod:
  items:
    - type: STR_WEAPON
      compatibleAmmo: !info     #this tag does not change anything, but when used it will show (in the log file) if the list supports this functionality or not
        - STR_AMMO_1
        - STR_AMMO_2
  
  #sub-mod
  items:
    - type: STR_WEAPON
      compatibleAmmo: !add      #now `STR_WEAPON` will have ammo list equal to `[STR_AMMO_1, STR_AMMO_2, STR_AMMO_3]`
        - STR_AMMO_3
  
  #another sub-mod
  items:
    - type: STR_WEAPON
      compatibleAmmo: !remove   #now `STR_WEAPON` will have ammo list equal to `[STR_AMMO_1, STR_AMMO_3]`
        - STR_AMMO_2


* <span style="background:#ddffdd;"> Another feature (added in OXCE v7.9) allows modders to better control how rulesets are overridden between mods and submods:</span>

  items: !info                # this tag can be used to check if a given ruleset supports the new features
    - type: STR_RANDOM        # from OXC, this was effectively split into `update:` and `new:` to make modder's intention clearer
    - delete: STR_X           # from OXC
    - new: STR_UNIQUE_NAME    # if an item with this name exists already (i.e. was created by another mod), the game raises a hard error
    - override: STR_OLD_NAME  # check if this name was used already and update the given item, hard error if the item did not exist
    - update: STR_OPTIONAL    # check if this name was used already and update the given item, do nothing if the item did not exist
    - ignore: STR_TECHNICAL   # don't load this ruleset directly (for example because it's used only as a YAML anchor)

=== metadata.yml ===

Special file that defines a mod's metadata.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| Mod's unique identifier.
| CrossPlatform::baseFilename(path)
|-
| '''name'''
| Mod's name.
| CrossPlatform::baseFilename(path)
|-
| '''description'''
| Mod's description.
| No description.
|-
| '''author'''
| Mod's author(s).
| unknown author
|-
| '''version'''
| Mod's version number. Recommended format is two or three numbers divided by a dot, e.g. '''9.9.9''' or '''1.5.12'''
| 1.0
|- style="background-color:#ddffdd;"
| '''versionDisplay'''
| More human friendly version number (for display purposes), can contain letters and other characters, e.g. '''1.5.12 Blue Skies edition'''.
| Same as '''version'''
|-
| '''isMaster'''
| Is this a master mod?
| false
|-
| '''master'''
| Unique identifier of this mod's required master mod. Use '''*''' to indicate that this mod can be used with any master mod.
| xcom1
|- style="background-color:#ddffdd;"
| '''requiredMasterModVersion'''
| Minimum version number of the required master mod.
| 
|-
| '''reservedSpace'''
| How much space (memory) is available for this mod's surface sets and sound sets. Allowed values: from 1 to 100. (1 = 1000 indices, 100 = 100000 indices.)
| 1
|-
| '''requiredExtendedEngine'''
| Name of an OpenXcom engine required by this mod. E.g. '''Extended'''.
|
|-
| '''requiredExtendedVersion'''
| Minimum version of an OpenXcom engine required by this mod. E.g. '''7.9'''.
|
|-
| '''loadResources'''
| '''DO NOT USE''' List of special directories where the game searches for OG resources.

Only relevant for ''top-level master mods'' (e.g. xcom1, xcom2).

Not relevant for normal mods (e.g. Final mod pack).

Also not relevant for master mods, which themselves have a master mod (e.g. XcomFiles, 40k, ...).
|
|-
| '''resourceConfig'''
| Name of a rule file where some OG resource mappings/definitions are located (transparency lookup table definitions, CAT file sound mappings). Usually file named '''vars.rul'''.

At the moment, the only reason why you might want to use this, is when you want to define your own transparency rules for projectile vapor particles.
|
|}

=== vars.rul ===

One file (per mod) selected by '''metadata.yml''', all such files are loaded before any other files in any active mod (since they have impact on how OG resources are loaded/processed).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''soundDefs'''
| Mapping of sound effects, between OG CAT file and the game's internal sound set(s).
|
|-
| '''transparencyLUTs'''
| Definitions of different types of transparency for projectile vapor trail.
|
|}

=== Starting Base ===

Defines the content of the base at the start of game.

<div style="background:#ddffdd;">In OXCE, you can optionally define different starting bases for each game difficulty using the following top-level names:
* startingBaseBeginner
* startingBaseExperienced
* startingBaseVeteran
* startingBaseGenius
* startingBaseSuperhuman

If you don't define some of them, the default starting base will be used instead of the missing ones.

The default starting base will also be used for New Battle screen.
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''randomSoldiers'''
| Determines number and type of starting X-Com soldiers.
If a mod contains more than one type of soldiers, this can also be specified with:
  randomSoldiers:
    STR_SOLDIER: 3
    STR_ANOTHER_SOLDIER: 7
| 0
|-
| '''scientists'''
| Determines number of starting scientists. 
| 0
|-
| '''engineers'''
| Determines number of starting engineers.
| 0
|-
| '''facilities'''
| List of starting base facilities and their position (x and y coordinates being 0-5).
| -
|-
| '''items'''
| List of starting items in the base, excluding items on crafts.
| -
|-
| '''crafts'''
| List of starting crafts in the base and items on board.
| -
|}

OpenXcom uses the same format to define a starting base as for saving/loading a real base (except for '''randomSoldiers''' attribute).
That means you can also define various other parameters in your mod, for example:
* <span style="background:#ddffdd;">predefined location (longitude and latitude in radians)</span>
* <span style="background:#ddffdd;">predefined name</span>
* predefined soldiers (if you don't like to start with randomly generated ones, but like it a bit more RPG)
* transfers that arrive at specified times (you could control various game events/progression with these items)
* base detected by aliens flag (which would allow you for example to start the campaign with an early scripted base defense mission)
* and so on...

The easiest way to create this ruleset, is to copy it from an existing saved game, correct the indentation and manually change the actual content.
The following table completes the list of highest-level attributes you can use.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''lon'''
| Longitude of the base location, in radians.
| 0.0
|- style="background-color:#ddffdd;"
| '''lat'''
| Latitude of the base location, in radians.
| 0.0
|- style="background-color:#ddffdd;"
| '''name'''
| Base name.
| -
|-
| '''soldiers'''
| List of starting base soldiers, their names, stats and everything else.
| -
|-
| '''transfers'''
| List of items, soldiers, engineers and/or scientists inbound to the starting base with a specified time lag.
| -
|-
| '''research'''
| List of ongoing research projects in the starting base.
| -
|-
| '''productions'''
| List of ongoing manufacturing projects in the starting base.
| -
|-
| '''retaliationTarget'''
| Flag saying whether the aliens know about your starting base or not.
| false
|}

=== Globe ===

Defines the drawing of landmasses and borders on the globe. Also defines mapping between geoscape textures and battlescape appearance.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''data'''
| Path to a file, which contains polygon and texture information. (For example WORLD.DAT).
| -
|-
| '''polygons'''
| List of polygons drawn on the globe surface. A triangle consist of seven values: the first number defines the texture, followed by three pairs of (x,y) globe coordinates. Only polygons with 3 or 4 vertices are reliably shown on the globe, i.e. 7 or 9 values per entry.

Note that:
* '''data''' and '''polygons''' define the same thing... use one or another, not both
* each time you define data or polygons, their previous definition is completely deleted (i.e. globe can be defined only as a whole, not incrementally)
| -
|-
| '''polylines'''
| List of border lines. Each list entry consist of a list of (x,y) globe coordinates.

Note that:
* each time you define polylines, their previous definition is completely deleted (i.e. they can be defined only as a whole, not incrementally)
| -
|-
| '''textures'''
| List of globe textures that determine the battlescape appearance of a certain place on the globe.
| -
|-
| '''countryColor'''
| Color of the country labels (0-255).
| 239
|-
| '''cityColor'''
| Color of the city labels (0-255).
| 138
|-
| '''baseColor'''
| Color of the xcom base labels (0-255).
| 133
|-
| '''lineColor'''
| Border line color (0-255).
| 162
|-
| '''oceanPalette'''
| Color range (defined as palette offset) of the "oceans", or better said of the "globe sections not covered by polygons" (0-15).
| 12
|-
| '''oceanShading'''
| Whether ocean shading (32-color) should be used or not.

Notes:
* normally land uses 16-color shading and ocean uses 32-color shading... where "ocean" is defined as "lack of texture", i.e. for UFO lack of land and for TFTD lack of water
* for hybrids (i.e. mods that combine UFO and TFTD textures together), there is no "ocean" anymore, because the globe is fully covered by textures (land and water textures)
* thus the original 32 colors used for ocean shading can be:
** re-used to provide more colors for the textures (2 distinct color ranges, 16 colors each)
** ignored for ocean shading purposes, and used for texture shading purposes instead
| true
|}

==== (Globe) Textures ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| ID of the texture.

* Terrain-based textures have positive IDs (0, 1, 2, ...) and are used for drawing globe polygons
* AlienDeployment-based textures have negative IDs (-1, -2, -3, ...) and are '''not''' used for drawing globe polygons
| required
|-
| '''terrain'''
| List of terrains (can be more than one) that correspond to each [[TEXTURE.DAT|Geoscape texture]].

Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lon2, lat1, lat2]'')''' and '''weight: NUMBER''' that gives their chance of appearance.

These textures are primarily used for UFO landing/crash sites.

Example 1:
 globe:
   textures:
     - id: 0
       terrain:
         - name: FOREST
           area: [0, 360, -90, 0]
         - name: JUNGLE
           area: [0, 360, 0, 90]

Example 2:
 globe:
   textures:
     - id: 11
       terrain:
         - name: PIPES
           weight: 50
         - name: SEABED
           weight: 25
         - name: CORAL
           weight: 25
| -
|-
| '''deployments'''
| Defined by weighted alien deployments (can be more than one), which determine appearance for mission sites (e.g. terror sites, artifact sites, shipping lanes, etc.).

Example:
 globe:
   textures:
     - id: -4
       deployments:
         STR_CARGO_SHIP_P1: 50
         STR_CRUISE_SHIP_P1: 50
| -
|- style="background-color:#ddffdd;"
| '''baseTerrain'''
| In OXCE, the terrain-based textures can additionally have separate terrain defined for base defense missions.

This terrain can be used in map scripting to replace the generic "dirt" blocks with something more fitting (e.g. snow in the arctic or jungle near the equator).

More info: https://openxcom.org/forum/index.php/topic,5108.0.html
| -
|- style="background-color:#ddffdd;"
| '''baseGridSprite'''
| Allows to override xcom base grid sprite (=sprite for a place with no base facility), based on the globe texture, where the base is located.

More info: https://openxcom.org/forum/index.php?topic=12800.0
| 0
|- style="background-color:#ddffdd;"
| '''startingCondition'''
| In OXCE, the textures can have their own starting conditions (with lower priority than deployment starting conditions).
| -
|- style="background-color:#ddffdd;"
| '''fakeUnderwater'''
| In OXCE, the (land) textures can also be flagged as fake underwater textures using this boolean attribute.

Such terrain can support underwater missions, underwater bases/facilities and have separate starting conditions.

More info: https://openxcom.org/forum/index.php/topic,11063.0.html
| false
|- style="background-color:#ddffdd;"
| '''isOcean'''
| In OXCE, the (land) textures can also be flagged as "being ocean", i.e. "not being a texture for anything other than drawing".

More info: https://openxcom.org/forum/index.php?topic=12439.0
| false
|}

=== Countries ===

Defines one of the [[Country Funding (EU)|funding nations]], listed in ''"countries:"''. They're used for activity graphs and player scoring.

<div style="background:#ddffdd;">In OXCE, the same kind of ruleset can be used to define "extra globe labels" so that you can label continents, or anything else on non-Earth globes (e.g. Moon, Mars, Dune, etc.). Of course, nothing is stopping you from using this on the Earth globe too. Listed under its own top-level category ''"extraGlobeLabels:"''.
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the country name.
| ''required''
|- style="background-color:#ddffdd;"
| '''provideBaseFunc'''
| A list of services an xcom base in this country provides after being built.
| -
|- style="background-color:#ddffdd;"
| '''forbiddenBaseFunc'''
| A list of services that cannot be used anymore after an xcom base is built in this country.
| -
|- style="background-color:#ddffdd;"
| '''signedPactEvent'''
| String ID of the event triggered when the country leaves Xcom project.
| -
|- style="background-color:#ddffdd;"
| '''rejoinedXcomEvent'''
| String ID of the event triggered when the country rejoins Xcom project.
| -
|-
| '''fundingBase'''
| Country's base funding, in thousands. The starting funding can be anywhere between 1x and 2x the base funding.
| 0
|-
| '''fundingCap'''
| Country's funding cap, in thousands. Once a country reaches this maximum, it will no longer increase its funding.
| 0
|-
| '''labelLon'''
'''labelLat'''
| Longitude and latitude coordinates of the country's label on the globe. This label is only shown when the globe is zoomed in and "detail" is turned on.
| 0.0
0.0
|- style="background-color:#ddffdd;"
| '''labelColor'''
| Color (0-255) of the country label.
| 0 (not used)
|-
| '''areas'''
| List of "rectangles" on the globe defined as [''lon1'' ''lon2'' ''lat1'' ''lat2'']. Any activity within these areas counts towards the country's graph activity and affects their opinion of the player.
| -
|- style="background-color:#ddffdd;"
| '''zoomLevel'''
| Minimum globe zoom level at which this extra globe label becomes visible.

Note: doesn't work for countries. Only for extra globe labels.
| 0
|}

=== Regions ===

Defines one of the [[Geoscape (EU)#World Regions/Countries|world regions]], listed in ''"regions:"''. They're used for base placement, activity graphs and mission spawning.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the region name.
| ''required''
|- style="background-color:#ddffdd;"
| '''provideBaseFunc'''
| A list of services an xcom base in this region provides after being built.
| -
|- style="background-color:#ddffdd;"
| '''forbiddenBaseFunc'''
| A list of services that cannot be used anymore after an xcom base is built in this region.
| -
|-
| '''cost'''
| Amount of money spent building an X-COM base in this region (first base is free).
| 0
|-
| '''areas'''
| List of "rectangles" on the globe defined as ''[lon1, lon2, lat1, lat2]''. Any activity within these areas counts towards the region's graph activity.

Example:
  regions:
    - type: STR_EUROPE
      areas:
        - [335, 60, -70, -35]
| -
|- style="background-color:#ddffdd;"
| '''deleteOldAreas'''
| Can be used in mods to delete areas defined by a parent mod.
| false
|-
| '''regionWeight'''
| Weight of this region when selecting regions for alien missions.
| 0
|-
| '''missionWeights'''
| Weighted list of the different mission types for this region (eg. ''STR_ALIEN_RESEARCH: 14'').
| -
|-
| '''missionZones'''
| List of mission zones. Mission zones are used for generating waypoints for UFO trajectories, and also for spawning mission sites and alien bases.
Each mission zone itself is a list of '''mission areas''', where each area is defined by:
* a "rectangle" (''[lon1, lon2, lat1, lat2]'') defining a relevant section of the globe (does not need to be within the region itself)
* or a single point (''[lon1, lon1, lat1, lat1]'') (a city) on the globe

Example:
 missionZones: 
   - - [326, 353, -85, -81]
     - [132, 173, -79, -76]
   - - [302, 323, -80, -78]
     - [62, 66, -76, -75]
Areas used for mission site spawning additionally have:
* a texture ID (from globe ruleset, this should be the alienDeployment-based texture, usually the ID is a negative number)
* and optionally a city string ID (will be displayed on the globe if defined)

Example:
 missionZones: 
   - - [326, 353, -85, -81, textureID, STR_CITY_NAME]
     - [132, 173, -79, -76, textureID, STR_CITY_NAME]

'''Important:''' Crossing the prime meridian in '''missionZones''' requires a different syntax - ''lon2'' cannot be smaller than ''lon1''! This syntax exception does not apply to region '''areas'''.

Example:
 # Wrong crossing:
 [350, 8, 20, 30]
 # Correct crossing:
 [350, 368, 20, 30]  # 368 (=8+360) also represents 8 degrees, and satisfies the ''lon2 >= lon1'' condition

| -
|-
| '''missionRegion'''
| Spawn mission in this region instead (used for regions without land).
| -
|}

=== Base Facilities ===

Defines one of the [[Base Facilities (EU)|facilities]] that can be built in an X-COM base, listed in ''"facilities:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the facility name.
| ''required''
|- style="background-color:#ddffdd;"
| '''ufopediaType'''
| String ID of alternate ufopedia article for this base facility (when accessed via middle-button click).

More info: https://openxcom.org/forum/index.php?topic=12813.0
| -
|- style="background-color:#ddffdd;"
| '''fakeUnderwater'''
| Defines whether the facility can be built in a standard base, fake underwater base (used by hybrid mods), or both.

Possible options:
* -1 = both (default)
* 0 = only standard base
* 1 = only fake underwater base
| -1
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this facility. If none are specified, this facility is unlocked from the start.
| -
|- style="background-color:#ddffdd;"
| '''requiresBaseFunc'''
| A list of services required to build this facility.
| -
|- style="background-color:#ddffdd;"
| '''provideBaseFunc'''
| A list of services this facility provides after being built.
| -
|- style="background-color:#ddffdd;"
| '''forbiddenBaseFunc'''
| A list of services that cannot be used anymore after this facility is built.
| -
|-
| '''spriteShape'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's outer shape in the Basescape and UFOpaedia.
| -1
|-
| '''spriteFacility'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's contents in the Basescape and UFOpaedia. Drawn on top of '''spriteShape'''. Not required for buildings size 2 or larger.
| -1
|- style="background-color:#ddffdd;"
| '''spriteEnabled'''
| Should '''spriteFacility''' over '''spriteShape''' behavior be enabled for this facility? (For 1x1 facilities, it's enabled by default, as in vanilla.)
| false
|- style="background-color:#ddffdd;"
| '''connectorsDisabled'''
| Should the game draw facility connectors leading from/to this facility in the base view?
| false
|- style="background-color:#ddffdd;"
| '''missileAttraction'''
| A weight (i.e. not a percentage) of how likely will alien missiles/bombardments hit this type of facility.
| 100
|- style="background-color:#ddffdd;"
| '''destroyedFacility'''
| String ID of the destroyed version of this facility (must have the same size).

Note: destruction can happen either in Base Defense mission or via Alien missiles/bombardment.
| -
|-
| '''lift'''
| Is this facility an [[Access Lift]]? All base facilities must be connected to the lift.
| false
|-
| '''hyper'''
| Is this facility a [[Hyperwave Decoder]]? Displays extra information for detected UFOs. Only valid for radar facilities. If "true", the radar detection chance will be taken from '''radarChance''' value.
| false
|-
| '''mind'''
| Is this facility a [[Mind Shield]]? Reduces the chance of UFOs finding your base. Does stack (detection chance is inversely proportional to the number of mind shields).
| false
|- style="background-color:#ddffdd;"
| '''mindPower'''
| The power of the mind shield provided by this facility.
| 1
|-
| '''grav'''
| Is this facility a [[Grav Shield]]? Each shield allows for an extra defense round in which all of your base defenses can fire again.
| false
|-
| '''size'''
| Size of the facility, in grid units. Every facility is square, so a size of 1 means 1x1, 2 means 2x2, etc. Bigger facilities are made up of multiple sprites, for example a 2x2 facility will use 4 sprites for '''spriteShape''' and 4 sprites for '''spriteFacility''' (top-left, top-right, bottom-left, bottom-right).
| 1
|- style="background-color:#ddffdd;"
| '''sizeX'''
| Size of the facility in the X direction. Overrides '''size'''.
| 1
|- style="background-color:#ddffdd;"
| '''sizeY'''
| Size of the facility in the Y direction. Overrides '''size'''.
| 1
|-
| '''buildCost'''
| Amount of money spent to build this facility in the base.
| 0
|- style="background-color:#ddffdd;"
| '''refundValue'''
| Amount of money refunded when the facility is dismantled.
| 0
|- style="background-color:#ddffdd;"
| '''buildCostItems'''
| Items needed to build a facility and items "refunded" when the facility is dismantled.

  - type: STR_MY_FACILITY
    buildCostItems:
      STR_ALIEN_ALLOYS:
        build: 100
        refund: 75
      STR_ALIEN_ENTERTAINMENT:
        build: 1
        refund: 1

| -
|-
| '''buildTime'''
| Amount of days it takes for this facility to be built.
| 0
|-
| '''monthlyCost'''
| Amount of money spent monthly for the maintenance of this facility.
| 0
|-
| '''storage'''
| Amount of storage space (for items) this facility provides. See [[Base Stores]].
| 0
|- style="background-color:#ddffdd;"
| '''storageTiles'''
| A list of tile positions where to place items in this facility's storage. If empty, vanilla checkerboard pattern will be used.
| -
|-
| '''personnel'''
| Amount of personnel (soldiers, scientsts, engineers) these quarters can contain.
| 0
|-
| '''aliens'''
| Amount of live aliens this facility can contain. Only checked if the ''storageLimitsEnforced'' option is enabled.
| 0
|- style="background-color:#ddffdd;"
| '''prisonType'''
| What type of prisoners (aliens) can be held in this facility.

More info: https://openxcom.org/forum/index.php/topic,4830.msg69933.html#msg69933
| 0
|-
| '''crafts'''
| Amount of X-COM craft this facility can contain.
| 0
|-
| '''labs'''
| Amount of lab space this facility provides for research projects.
| 0
|-
| '''workshops'''
| Amount of workshop space this facility provides for manufacture projects.
| 0
|-
| '''psiLabs'''
| Amount of soldier space this facility provides for psionic training.
| 0
|- style="background-color:#ddffdd;"
| '''trainingRooms'''
| Amount of soldier space this facility provides for combat/martial training.
| 0
|-
| '''radarRange'''
| Maximum radar detection range of this facility, in nautical miles.
| 0
|-
| '''radarChance'''
| Chance (0-100%) of this radar detecting a UFO that enters its range.
| 0
|- style="background-color:#ddffdd;"
| '''sightRange'''
| Range at which the facility can detect alien bases in nautical miles.
| 0
|- style="background-color:#ddffdd;"
| '''sightChance'''
| Chance (0-100%) of this facility detecting an alien base that enters its sight range. More info: https://openxcom.org/forum/index.php/topic,8119.0.html
| 0
|-
| '''defense'''
| Offensive power provided by this base defense against attacking UFOs.
| 0
|-
| '''hitRatio'''
| Chance (0-100) of the base defense hitting an attacking UFO.
| 0
|- style="background-color:#ddffdd;"
| '''unifiedDamageFormula'''
| Should unified damage formula/approach be used?

More info: https://openxcom.org/forum/index.php?topic=12315.0
| false
|- style="background-color:#ddffdd;"
| '''shieldDamageModifier'''
| Defines the percent of power that a weapon does to shields (during base defense).
| 100
|- style="background-color:#ddffdd;"
| '''ammoItem'''
| Specifies the ammo item needed for this facility during base defense. More info: https://openxcom.org/forum/index.php/topic,7651.msg133495.html#msg133495
| -
|- style="background-color:#ddffdd;"
| '''ammoMax'''
| Specifies the maximum amount of ammo that can be loaded into this air defense system.

More info: https://openxcom.org/forum/index.php/topic,11760.0.html
| 0
|- style="background-color:#ddffdd;"
| '''rearmRate'''
| Specifies how much ammunition will be loaded into this air defense system per game hour.
| 1
|- style="background-color:#ddffdd;"
| '''ammoNeeded'''
| Specifies the amount of ammo spent when firing once.
| 1
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense fires.
| 0
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense hits a target.
| 0
|- style="background-color:#ddffdd;"
| '''placeSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the facility is placed (or when the facility remains after dismantling another facility).
| 0
|-
| '''mapName'''
| [[MAPS|Map]] associated to this facility in Battlescape base defenses.
| -
|- style="background-color:#ddffdd;"
| '''verticalLevels'''
| Can be used instead of '''mapName'''. Allows generating a base facility map as if it were an ''addBlock'' map script command.

More info: https://openxcom.org/forum/index.php/topic,5316.0.html
| -
|- style="background-color:#ddffdd;"
| '''maxAllowedPerBase'''
| Maximum number of facilities of this type allowed to be built per base.
| 0 (not used)
|- style="background-color:#ddffdd;"
| '''manaRecoveryPerDay'''
| How much mana does the facility recover per day. The facility setting is NOT cumulative, more facilities don't provide more regen. If there are multiple facilities of different type with different regen rate, the best (highest) regen rate is used.
| 0
|- style="background-color:#ddffdd;"
| '''healthRecoveryPerDay'''
| How much health/HP does the facility recover per day. The facility setting is NOT cumulative, more facilities don't provide more regen. If there are multiple facilities of different type with different regen rate, the best (highest) regen rate is used.

FIXME: add a link to more detailed description of this feature!
| 0
|- style="background-color:#ddffdd;"
| '''sickBayAbsoluteBonus'''<br/>'''sickBayRelativeBonus'''
| How much additional HP is healed per day.

  - type: STR_FIELD_HOSPITAL
    sickBayAbsoluteBonus: 0.75
    sickBayRelativeBonus: 0.0
  - type: STR_SURGERY_ROOM
    sickBayAbsoluteBonus: 0.25
    sickBayRelativeBonus: 1.0
  - type: STR_REGENERATION_ROOM
    sickBayAbsoluteBonus: 0.0
    sickBayRelativeBonus: 10.0
  - type: STR_GOAULD_SARCOPHAGUS
    sickBayAbsoluteBonus: 90.0
    sickBayRelativeBonus: 0.0

Examples, considering the ruleset above:
* with no facilities: 1 hp healed per day
* with one field hospital: 1.75 hp per day
* with one surgery room: 1.25 hp per day + 1% of soldier's max hp
* with 2 field hospitals and 2 surgery rooms: 3 hp per day + 2% of soldier's max hp
* with regeneration room: 10% of soldier's max hp... i.e. fully recovered in 10 days or less
* with Goa'uld sarcophagus: 90 hp per day... i.e. fully healed overnight
| 0.0<br/>0.0
|- style="background-color:#ddffdd;"
| '''leavesBehindOnSell'''
| A facility to leave behind a dismantled facility (must be of the same size); or a list of 1x1 facilities to fill in the old facility's place.
| -
|- style="background-color:#ddffdd;"
| '''removalTime'''
| How long facilities left behind when this one is sold should take to build.

Possible options:
* -1 = take '''buildTime''' from the other facilities' rulesets
* 0 = instant
* 1+ = that many days

Note: doesn't do anything without '''leavesBehindOnSell'''
| 0
|- style="background-color:#ddffdd;"
| '''canBeBuiltOver'''
| Can this facility be built over?
| false
|- style="background-color:#ddffdd;"
| '''upgradeOnly'''
| False = a normal facility; true = cannot be built from scratch, can only be upgraded to.
| false
|- style="background-color:#ddffdd;"
| '''buildOverFacilities'''
| A list of other base facilities this one can be built over. If empty, it can be built over anything with ''canBeBuiltOver: true''.
| -
|- style="background-color:#ddffdd;"
| '''rightClickActionType'''
| Which screen should open when R-clicking on this facility in the base view?

Possible options:
* 0 = OpenXcom default
* 1 = Prison (Alien Containment)
* 2 = Manufacturing
* 3 = Research
* 4 = Martial Training
* 5 = Psi Training
* 6 = Barracks
* 7 = Market (Sell)
* other = go to Geoscape
| 0
|}

=== Crafts ===

Defines one of the [[Craft|X-COM crafts]] that go on interception missions, listed in ''"crafts:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the craft name.
| ''required''
|- style="background-color:#ddffdd;"
| '''selectSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when a craft is selected on the globe. Can be a list with multiple options.

More info: https://openxcom.org/forum/index.php/topic,10195.msg143053.html#msg143053
| -
|- style="background-color:#ddffdd;"
| '''takeoffSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when a craft is taking off from a base. Can be a list with multiple options.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this craft. If none are specified, this craft is unlocked from the start.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyBaseFunc'''
| A list of services required to buy this craft.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyCountry'''
| An allied country required to be able to buy this craft.
| -
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw this craft in the Basescape and from [[INTICON.PCK]] used to draw the damage indicator in dogfights.

Note that:
* the corresponding id for INTICON.PCK for the minimized craft icon is sprite+0
* the corresponding id for INTICON.PCK for the dogfight image is sprite+11
* the corresponding id for BASEBITS.PCK is sprite+33
| -1
|- style="background-color:#ddffdd;"
| '''maxSkinIndex'''
| A maximum number of skins supported by this craft. Zero-based. I.e. a craft with 4 possible skins should set this attribute to 3.
| 0
|- style="background-color:#ddffdd;"
| '''skinSprites'''
| A list of additional '''sprite'''s used for alternate craft skins.
| -
|-
| '''marker'''
| Sprite ID from GlobeMarkers spritesheet, used for drawing craft icon on the globe. Usually 3x3 pixels, but can be modded to be bigger.

Note: if not modded, sprite id 1 is used (=vanilla craft marker)
| -1
|-
| '''weapons'''
| Amount of craft weapons this craft can equip. The UI can only display a max of 2 weapons.

<span style="background:#ddffdd;">In OXCE, you can have up to '''4 weapons''' (or other accessories)</span>
| 0
|- style="background-color:#ddffdd;"
| '''weaponTypes'''
| A list defining compatible weapon types for this craft type. Up to 4 slots, and each slot can have up to 4 compatible weapon types.

Example: [0, [0, 1], [2,3], [0,2,4]]
| [0, 0, 0, 0]
|- style="background-color:#ddffdd;"
| '''weaponStrings'''
| A list describing the craft's weapon slots (up to 4 slots).
| [STR_WEAPON_ONE, STR_WEAPON_TWO]
|- style="background-color:#ddffdd;"
| '''fixedWeapons'''
| A list with fixed built-in craft weapons (up to 4 slots). More info: https://openxcom.org/forum/index.php/topic,9047.0.html
| -
|-
| '''soldiers'''
| Amount of units (soldiers and vehicles) this craft can carry.
| 0
|- style="background-color:#ddffdd;"
| '''allowedSoldierGroups'''
| List of soldier type groups allowed onboard. If empty, no restriction.
| -
|- style="background-color:#ddffdd;"
| '''allowedArmorGroups'''
| List of armor groups allowed onboard. If empty, no restriction.
| -
|- style="background-color:#ddffdd;"
| '''onlyOneSoldierGroupAllowed'''
| Whether only one soldier type group (can consist of multiple soldier types) is allowed onboard.
| false
|- style="background-color:#ddffdd;"
| '''maxUnitsLimit'''
| Amount of units (soldiers and vehicles) this craft can carry, INCLUDING all potential extensions provided by craft weapons/modules.
| same as '''soldiers'''
|-
| '''vehicles'''
| Amount of vehicles this craft can carry.

<span style="background:#ddffdd;">Note: in OXCE, it's the amount of vehicles '''and''' 2x2 soldiers. In OXCE, it can also have a value of -1, which means unlimited. Since OXCE v7.10, value -1 is '''not''' supported anymore.</span>
| 0
|- style="background-color:#ddffdd;"
| '''maxHWPUnitsLimit'''
| Amount of vehicles and 2x2 soldiers this craft can carry, INCLUDING all potential extensions provided by craft weapons/modules.
| same as '''vehicles'''
|- style="background-color:#ddffdd;"
| '''pilots'''
| How many pilots are required to pilot this craft.

Notes:
* pilots are also soldiers and will be fighting in the Battlescape
* pilots give bonuses/penalties to the craft performance in the Dogfights (based on their skills)
* pilots gain experience via Dogfights
* you can manually assign pilots to the craft; if you don't want to, they can be assigned automatically
| 0
|- style="background-color:#ddffdd;"
| '''pilotMinStatsRequired'''
| Minimum stats a soldier needs to be eligible for piloting this craft.
| -
|- style="background-color:#ddffdd;"
| '''pilotSoldierBonusesRequired'''
| A list of soldier bonuses a soldier needs to be eligible for piloting this craft.
| -
|- style="background-color:#ddffdd;"
| '''allowLanding'''
| Should this craft be able to start a Battlescape mission?

Note: you may want to set ''false'' to your manned/piloted interceptors.
| true
|- style="background-color:#ddffdd;"
| '''maxSmallSoldiers'''
| Maximum amount of 1x1 soldiers this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxLargeSoldiers'''
| Maximum amount of 2x2 soldiers this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxSmallVehicles'''
| Maximum amount of 1x1 vehicles this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxLargeVehicles'''
| Maximum amount of 2x2 vehicles this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxSmallUnits'''
| Maximum amount of 1x1 soldiers and 1x1 vehicles this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxLargeUnits'''
| Maximum amount of 2x2 soldiers and 2x2 vehicles this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxSoldiers'''
| Maximum amount of 1x1 soldiers and 2x2 soldiers this craft can carry. (-1 = unlimited)
| -1
|- style="background-color:#ddffdd;"
| '''maxVehicles'''
| Maximum amount of 1x1 vehicles and 2x2 vehicles this craft can carry. (-1 = unlimited)
| -1
|-
| '''costBuy'''
| Amount of money spent for purchasing this craft. If set to 0, the craft will not be available in the Purchase/Recruit screen.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimit'''
| How many craft of this type you can purchase per month. 0 = infinite.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimitMessage'''
| Custom message for '''monthlyBuyLimit'''. More info: https://openxcom.org/forum/index.php?topic=12812.0
| -
|-
| '''costRent'''
| Amount of money spent monthly for renting this craft. If set to 0, the craft is not on rental and won't count towards base maintenance.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this craft.
| 0
|- style="background-color:#ddffdd;"
| '''forceShowInMonthlyCosts'''
| Forces this craft type to appear in Monthly Costs breakdown, even if not present at the base.

Note: Skyranger, Interceptor, Triton and Barracuda have this turned on (for backwards-compatibility).
| false
|-
| '''refuelItem'''
| Item required for refueling this craft. If no item is specified, the craft uses human fuel.
| 0
|-
| '''repairRate'''
| Amount of damage restored every hour while [[Repairs|Repairing]] in base.
| 1
|-
| '''refuelRate'''
| Amount of fuel restored every 30 mins while [[Refueling]] in base. If specified, a '''refuelItem''' is spent each time.
| 1
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this craft to a base.
| 0
|-
| '''score'''
| [[Score]] lost when this craft is destroyed.
| 0
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this craft in Battlescape missions.
| -
|- style="background-color:#ddffdd;"
| '''craftInventoryTile'''
| Coordinates [x, y, z] of the craft inventory tile (weapon's pile) in the craft. If not specified, tile occupied by the first soldier is used.

Note: You can change this attribute only if your mod also contains the '''battlescapeTerrainData''' attribute. Since OXCE 7.4.4 this limitation doesn't apply.

Note: Since OXCE 7.4.6 this attribute can be used also on craft that don't use '''deployment''', for example STR_SKYRANGER.
| -
|- style="background-color:#ddffdd;"
| '''mapVisible'''
| Should the craft map be visible at the beginning of the battle? Used for some funky effects (see W40k mod for examples).
| true
|- style="background-color:#ddffdd;"
| '''groups'''
| Tags the craft for purpose of map scripting.

More info: https://openxcom.org/forum/index.php/topic,10713.msg161170.html#msg161170
| -
|-
| '''deployment'''
| Custom positions for the unit deployment in the craft, listed as: ''[x, y, z, facing]''
If not specified, units are placed on empty spots from top-left to bottom-right facing top-right.
| -
|- style="background-color:#ddffdd;"
| '''useAllStartTiles'''
| Should the craft preview features use all spawnable/start tiles or only the ones specified by the '''deployment''' ?

More info: https://openxcom.org/forum/index.php/topic,10370.msg144057.html#msg144057
| false
|- style="background-color:#ddffdd;"
| '''customPreview'''
| String ID of an alien deployment that should be used for craft preview (overrides the default alien deployment STR_CRAFT_DEPLOYMENT_PREVIEW).
| -
|- style="background-color:#ddffdd;"
| '''keepCraftAfterFailedMission'''
| Defines whether the craft should be lost after a failed mission or not. Useful for example to implement paratroopers; or any kind of troop deployment without a craft physically being on the map.
| false
|-
| '''spacecraft'''
| Can this craft go to [[Cydonia]]?
| false
|- style="background-color:#ddffdd;"
| '''notifyWhenRefueled'''
| Should a pop up window inform the player once this craft is fully refueled?
| false
|- style="background-color:#ddffdd;"
| '''undetectable'''
| Can this craft be detected by alien bases and alien hunter-killers? Primarily meant for stationary radar craft or satellites.
| false
|- style="background-color:#ddffdd;"
| '''autoPatrol'''
| Should this craft automatically return to its patrol destination after refueling?
| false
|-
| '''maxAltitude'''
| Maximum altitude (0-4) this craft can dogfight to.
| -1
|- style="background-color:#ddffdd;"
| '''defaultAltitude'''
| Altitude displayed on the GUI when a craft doesn't follow any UFO (or the UFO is crashed/landed).
| STR_VERY_LOW
|-
| '''maxItems'''
| Amount of items this craft can carry.

<span style="background:#ddffdd;">'''Note:''' In OXCE, the default for a craft is 999999.</span>
| 0
|- style="background-color:#ddffdd;"
| '''shieldRechargedAtBase'''
| How many shield points are recharged when landed at base per hour.
| 1000
|- style="background-color:#ddffdd;"
| '''missilePower'''
| Turns a craft into a missile.

More info: https://openxcom.org/forum/index.php?topic=12377.0
| 0
|}

==== Craft Stats ====

The following attributes define so called "craft stats". They are listed in a separate table, just for convenience... but are still part of the Craft ruleset.

<span style="background:#ddffdd;">'''Note:''' In OXCE, all these stats are dynamic, i.e. can be modified by equipping craft weapons/accessories.</span>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''fuelMax'''
| Maximum amount of fuel this craft can carry. Crafts use up fuel based on their speed while traveling.
| 0
|-
| '''damageMax'''
| Maximum amount of damage this craft can take. If this amount is exceeded, the craft is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles. Crafts travel at max speed when flying and half speed when patrolling.
| 0
|-
| '''accel'''
| Acceleration value shown in the UFOpaedia.
| 0
|-
| '''radarRange'''
| Detection range of the craft's radar in nautical miles. Every craft radar has a detection chance dependent on its '''radarChance'''.
| 672
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''sightRange'''
| Range at which the craft can detect alien bases in nautical miles.
| 1696
|- style="background-color:#ddffdd;"
| '''hitBonus'''
| Flat bonus percentage to hit chances of all equipped weapons.
| 0
|- style="background-color:#ddffdd;"
| '''avoidBonus'''
| Flat bonus percentage to dodge chances against enemy fire (during dogfight).
| 0
|- style="background-color:#ddffdd;"
| '''avoidBonus2'''
| Flat bonus percentage to dodge chances against enemy fire (during xcom base defense). Not used/relevant.
| 0
|- style="background-color:#ddffdd;"
| '''powerBonus'''
| Multiplier for the power of craft weapons, e.g. 20 = weapons' power increased to 120% of their original power, -20 = decreased to 80%.
| 0
|- style="background-color:#ddffdd;"
| '''armor'''
| Amount of blocked damage per hit.
| 0
|- style="background-color:#ddffdd;"
| '''shieldCapacity'''
| Craft's maximum shield capacity.
| 0
|- style="background-color:#ddffdd;"
| '''shieldRecharge'''
| Defines the percent chance of recharging a point of shielding per game second (GS) during a Dogfight. Values under 100 are the percent chance, for over 100, every +100 means an automatic +1 to shields per GS. Thus ''shieldRecharge: 250'' means +2 shields/GS, with a 50% chance of +1 more.
| 0
|- style="background-color:#ddffdd;"
| '''shieldRechargeInGeoscape'''
| Similar to '''shieldRecharge''', but acts every 5 seconds in the Geoscape. Giving it a value of -1 means instant recharge as soon as 5 seconds pass!
| 0
|- style="background-color:#ddffdd;"
| '''shieldBleedThrough'''
| Defines the percent of damage that passes the shield when it goes down.  A value of 0 means that with even just 1 shield point, any single hit will be blocked, while 100 means 100% of the damage left after the shield blocks it will go on to damage the craft.
| 0
|- style="background-color:#ddffdd;"
| '''soldiers'''
| Amount of units (soldiers and vehicles) this craft can carry.
| 0
|- style="background-color:#ddffdd;"
| '''vehicles'''
| Amount of vehicles and 2x2 soldiers this craft can carry.
| 0
|- style="background-color:#ddffdd;"
| '''maxItems'''
| Amount of items this craft can carry.

Default for a craft is 999999. Default for a craft weapon/module is 0.
| 0
|- style="background-color:#ddffdd;"
| '''maxStorageSpace'''
| Total size of items/equipment this craft can carry. Does not include HWP, HWP ammo and armor worn by soldiers.

Default for a craft is 99999.0. Default for a craft weapon/module is 0.0.
| 0.0
|}

=== Craft Weapons ===

Defines one of the [[Craft Armaments|weapons]] equipped by X-COM craft for shooting down UFOs, listed in ''"craftWeapons:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the weapon name.
| ''required''
|- style="background-color:#ddffdd;"
| '''ufopediaType'''
| String ID of alternate ufopedia article for this craft weapon (when accessed via middle-button click).

More info: https://openxcom.org/forum/index.php?topic=12813.0
| -
|- style="background-color:#ddffdd;"
| '''tooltip'''
| A weapon's configurable tooltip on the UI. See https://openxcom.org/forum/index.php?topic=12154.0
| -
|- style="background-color:#ddffdd;"
| '''weaponType'''
| A weapon's type/category. Used to limit certain weapons/accessories to certain craft weapon slots.
| 0
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the weapon in the Basescape and from [[INTICON.PCK]] used to draw the weapon in dogfights.

Note that:
* the corresponding id for INTICON.PCK is sprite+5
* the corresponding id for BASEBITS.PCK is sprite+48
| -1
|-
| '''sound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when this weapon fires.
| -1
|- style="background-color:#ddffdd;"
| '''stats'''
| Contains the same set of attributes as [[#Craft Stats|Craft Stats]]. These dynamically increase/decrease the stats of a craft, when equipped.

Examples:
* you can increase the craft's range by equipping an extra fuel tank
* you can increase the craft's hit chance by equipping advanced targeters
* you can increase the craft's radar range/chance by equipping an extra radar
* you can increase the craft's crew capacity by equipping an extra cargo module
* and so on...
| -
|- style="background-color:#ddffdd;"
| '''hidePediaInfo'''
| Allows hiding the weapon's stats in the Ufopedia.

Note: this can be used for example when the craft weapon is not really a weapon, but only an equipment/booster (e.g. radar booster, extra fuel tank, etc.).
| false
|-
| '''damage'''
| Amount of damage this weapon does to enemy UFOs.
| 0
|- style="background-color:#ddffdd;"
| '''unifiedDamageFormula'''
| Should unified damage formula/approach be used?

More info: https://openxcom.org/forum/index.php?topic=12315.0
| false
|- style="background-color:#ddffdd;"
| '''shieldDamageModifier'''
| Defines the percent of power that a weapon does to shields.
| 100
|-
| '''range'''
| Maximum range of this weapon in dogfights (in kilometers).
| 0
|-
| '''accuracy'''
| Chance (0-100%) of each shot hitting the enemy UFO.
| 0
|-
| '''reloadCautious'''
| Time this weapon takes to fire between each shot in ''Cautious Mode''.
| 0
|-
| '''reloadStandard'''
| Time this weapon takes to fire between each shot in ''Standard Mode''.
| 0
|-
| '''reloadAggressive'''
| Time this weapon takes to fire between each shot in ''Aggressive Mode''.
| 0
|-
| '''ammoMax'''
| Maximum amount of ammo this weapon can carry.
| 0
|-
| '''rearmRate'''
| Amount of ammo restored every hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''clipSize'''. If the '''clipSize''' of the specified ammo is 0, no '''clip'''s are spent. 
| 1
|- style="background-color:#ddffdd;"
| '''bulletSaving'''
| Should statistical bullet saving apply for this craft weapon?
| false
|-
| '''projectileType'''
| Type of the weapon projectile, used for the projectile sprite in dogfights:
* 0 - [[Stingray]]
* 1 - [[Avalanche]]
* 2 - [[Cannon]]
* 3 - [[Fusion Ball]]
* 4 - [[Laser Cannon]]
* 5 - [[Plasma Beam]]
| 2
|-
| '''projectileSpeed'''
| Speed of the weapon projectile in dogfights.
| 0
|-
| '''launcher'''
| String ID of the [[#Items|item]] required to equip this weapon.
| ''required''
|-
| '''clip'''
| String ID of the [[#Items|item]] required to rearm this weapon.
| -
|-
| '''underwaterOnly'''
| Is this craft weapon restricted to underwater use only?
| false
|- style="background-color:#ddffdd;"
| '''tractorBeamPower'''
| How much the weapon slows down the maximum speed of a UFO when it's in range and the weapon is active.

Note: Tractor beams allow you to effectively decrease the maximum speed of a UFO during interception, preventing their escape.  If you have powerful enough beams targeting the UFO, you can even cause it to land or splash down in the water!
| 0
|}

=== Items ===

Defines the Geoscape and Battlescape properties of an [[Equipment (EU)|item]] that can be stored in X-COM bases, listed in ''"items:"''.

==== Naming, Categorization and Storage ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the internal item name.
| ''required''
|- style="background-color:#ddffdd;"
| '''loadOrder'''
| Allows specifying load order/priority for loading ammo into a weapon.

More info: https://openxcom.org/forum/index.php?topic=12500.0
| same as '''listOrder'''
|- style="background-color:#ddffdd;"
| '''ufopediaType'''
| String ID of alternate ufopedia article for this item (when accessed via middle-button click).

More info: https://openxcom.org/forum/index.php/topic,8707.msg154796.html#msg154796
| -
|-
| '''name'''
| String ID of the displayed item name, for cases where it's different from the internal name. If omitted, '''type''' is used. Only affects inventory screens and battlescape internals. Does not change the name of items in geoscape lists.
| =type
|- style="background-color:#ddffdd;"
| '''nameAsAmmo'''
| Extension for the name of weapons loaded with this item as ammo.
| -
|-
| '''battleType'''
| Defines the weapon's behavior in the Battlescape:
* 0 - None (Geoscape-only item)
* 1 - [[Weapons|Firearm]]
* 2 - Ammo
* 3 - Melee
* 4 - [[Grenade]]
* 5 - [[Proximity Grenade]]
* 6 - [[Medi-Kit (EU)|Medi-Kit]]
* 7 - [[Motion Scanner]]
* 8 - [[Mind Probe]]
* 9 - [[Psi-Amp]]
* 10 - [[Electro-flare]]
* 11 - Corpse
| 0
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this item. If none are specified, this item is unlocked from the start. Soldiers can only use unlocked items in the Battlescape.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuy'''
| A list of research topics required to be able to buy this item.

Note: you ''can'' use the item even if the requirements are not met... you just can't buy it.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyCountry'''
| An allied country required to be able to buy this item.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyBaseFunc'''
| A list of services (for a given base) required to be able to buy this item.
| -
|-
| '''size'''
| Space occupied by this item in [[Base Stores]]. Can be a decimal value.
| 0.0
|-
| '''costBuy'''
| Amount of money spent for purchasing this item. If set to 0, this item will not be available in the Purchase/Recruit screen.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimit'''
| How many items of this type you can purchase per month. 0 = infinite.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimitMessage'''
| Custom message for '''monthlyBuyLimit'''. More info: https://openxcom.org/forum/index.php?topic=12812.0
| -
|-
| '''costSell'''
| Amount of money gained for selling this item.
| 0
|- style="background-color:#ddffdd;"
| '''sellActionMessage'''
| Text/error to be shown when the player tries to sell this item. To ignore this check (and sell the item anyway), hold Shift.
| -
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this item to a base.
| 24
|- style="background-color:#ddffdd;"
| '''categories'''
| A list of [[#Item Categories|categories]] this item belongs to.
| -
|- style="background-color:#ddffdd;"
| '''monthlyMaintenance'''
| Monthly maintenance cost of items in Stores. For example your tanks could have a small monthly maintenance cost.
| 0
|- style="background-color:#ddffdd;"
| '''monthlySalary'''
| Monthly salary of "other employees" (represented as items in Stores). This is practically identical to monthlyMaintenance, it just shows on a different place in the [Monthly costs] screen.

Note: the "other employees" can't do much (yet), but you could use them for example to increase your Stores capacity (by giving them negative '''size''')... representing increased storage effectiveness by hiring specialized logistics personnel (or outsourcing storage completely).
| 0
|}

==== Sprites and Particles ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''customItemPreviewIndex'''
| Allows to have different icons for different types of Vehicles (HWP/SWS) on the [Craft Info] screen. Defined either as a single index into the CustomItemPreviews spritesheet, or as a list of indices (for bigger icons). 

Since OXCE v7.13: Ability to use `customItemPreviewIndex` for normal items too: https://openxcom.org/forum/index.php?topic=12122.0
| -
|-
| '''bigSprite'''
| Sprite ID from [[BIGOBS.PCK]] used to draw this item in a soldier's inventory and UFOpaedia.
| -1
|- style="background-color:#ddffdd;"
| '''specialIconSprite'''
| Sprite ID from [[SPICONS.DAT]] used to draw this item when used as '''specialWeapon''' (in Armor definition).
| -1
|-
| '''floorSprite'''
| Sprite ID from [[FLOOROB.PCK]] used to draw this item on the floor of a Battlescape tile.
| -1
|-
| '''handSprite'''
| Sprite ID from [[HANDOB.PCK]] used to draw this item on a soldier's hand in the Battlescape.
modders: each handobject needs 8 images (8 directions) define the extrasprites accordingly
| 120
|-
| '''bulletSprite'''
| Sprite ID from ''BulletSprites.png'' used to draw this weapon's/ammo's projectile on the Battlescape, with ammo's value overriding weapon's:
* 0 - [[Rocket Launcher]]
* 1 - [[Pistol]]
* 2 - [[Rifle]]
* 3 - [[Auto Cannon]]
* 4 - [[Heavy Cannon]]
* 5 - [[Laser Pistol]]
* 6 - [[Laser Rifle]]
* 7 - [[Heavy Laser]]
* 8 - [[Plasma Rifle|Plasma]]
* 9 - [[Small Launcher]]
* 10 - [[Blaster Launcher]]
for modders: the bulletsprite needs to be put into the extraSprites type "Projectiles" the bulletsprite can contain up to 35 3x3 images. The corresponding file id is 35*[bulletSprite]
| -1
|-
| '''bulletSpeed'''
| How much faster (or slower, if you use a negative number) is a projectile fired from this weapon/ammo compared to the default, with ammo values overriding weapon's. Defined as a whole number that will be added to the user set bullet speed (1-20).
| 0
|-
| '''explosionSpeed'''
| How much faster (or slower, if you use a negative number) is an explosion (hitAnimation) of this item animated compared to the default (50). Defined as a whole number. 

Note: The actual formula is as follows: (default - (10 * explosionSpeed)) = result smaller than default (50) means faster animation and vise-versa; can't go bellow 1.
| 0
|-
| '''turretType'''
| Sprite ID from [[TANKS.PCK]] of the turret to assign to this tank:
* 0 - [[Tank/Cannon]]
* 1 - [[Tank/Rocket Launcher]]
* 2 - [[Tank/Laser Cannon]]
* 3 - [[Hovertank/Plasma]]
* 4 - [[Hovertank/Launcher]]
| -1
|-
| '''vaporColor'''
| The color offset (0-3 in TFTD) to use for the vapor trail of projectiles fired from this weapon/ammo.

Note: If used on ammo, overrides weapon's values. This is also the case for other vapor values.
| -1
|-
| '''vaporDensity'''
| The vapor cloud density (number of particles) for the vapor trail.
| 0
|-
| '''vaporProbability'''
| The vapor cloud probability (0-100%) for the vapor trail.
| 15
|- style="background-color:#ddffdd;"
| '''vaporColorSurface'''
| The color offset (0-3 in TFTD) to use for the vapor trail (for surface deployments, i.e. non-underwater).
Note:
The '''vaporColor''' and '''vaporColorSurface''' indices are mod-specific since OXCE 7.1, not global anymore. If you want to use a vapor color from a parent mod, you need to specify it explicitly, for example:

  vaporColor: { mod: xcom2, index: 0 }

instead of

  vaporColor: 0
| -1
|- style="background-color:#ddffdd;"
| '''vaporDensitySurface'''
| The vapor cloud density (number of particles) for the vapor trail (for surface deployments, i.e. non-underwater).
| 0
|- style="background-color:#ddffdd;"
| '''vaporProbabilitySurface'''
| The vapor cloud probability (0-100%) for the vapor trail (for surface deployments, i.e. non-underwater).
| 15
|}

==== Sounds and Animations ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''explosionHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when explosion happens. Can be a list with multiple options. If not specified, default explosion sound is used.
| -
|- style="background-color:#ddffdd;"
| '''reloadSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this ammo/weapon is reloaded, with ammo's value overriding weapon's. Can be a list with multiple options. If not specified, default reload sound is used.
| -
|- style="background-color:#ddffdd;"
| '''primeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this item is primed. Can be a list with multiple options.
| -
|- style="background-color:#ddffdd;"
| '''unprimeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this item is unprimed. Can be a list with multiple options.
| -
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon/ammo is fired, with ammo's value overriding weapon's. <span style="background:#ddffdd;">In OXCE, can be a list with multiple options.</span>
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target. <span style="background:#ddffdd;">In OXCE, can be a list with multiple options.</span>
| -1
|- style="background-color:#ddffdd;"
| '''psiSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon performs a psi attack (only Panic/MindControl). Can be a list with multiple options.
| -
|- style="background-color:#ddffdd;"
| '''hitMissSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon misses a psi attack (Use/Panic/MindControl). Can be a list with multiple options.
| -
|- style="background-color:#ddffdd;"
| '''psiMissSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon misses a psi attack (only Panic/MindControl). Can be a list with multiple options.
| -
|-
| '''meleeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon attacks a target with melee. <span style="background:#ddffdd;">In OXCE, can be a list with multiple options.</span>
| 39
|-
| '''meleeHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target with melee. <span style="background:#ddffdd;">In OXCE, can be a list with multiple options.</span>
| -1
|- style="background-color:#ddffdd;"
| '''meleeMissSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon misses a target with melee. Can be a list with multiple options.
| -
|-
| '''hitAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "hit explosion". <span style="background:#ddffdd;">In OXCE, it applies also to Use action of psi weapons.</span>
'''NOTE''': Do not define this value for melee/psi weapons, they use [[HIT.PCK]] and therefore meleeAnimation instead.

'''NOTE''': Explosive style weapons (Damage type: smoke, incendiary, stun, & High Explosive) use [[X1.PCK]] and should always be set to the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images. 
| -1
|- style="background-color:#ddffdd;"
| '''hitAnimFrames'''
| Allows overriding number of frames for '''hitAnimation'''.

Defaults are:
* bullet impact animations = 10 frames
* melee/psi animations = 4 frames
* explosion animations = 8 frames
| -1
|- style="background-color:#ddffdd;"
| '''hitMissAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "miss explosion". Applies only to Use action of psi weapons.
| -1
|- style="background-color:#ddffdd;"
| '''hitMissAnimFrames'''
| Allows overriding number of frames for '''hitMissAnimation'''.
| -1
|-
| '''meleeAnimation'''
| Sprite ID from HIT.PCK played when this weapon hits a target with melee.
| 0
|- style="background-color:#ddffdd;"
| '''meleeAnimFrames'''
| Allows overriding number of frames for '''meleeAnimation'''.
| -1
|- style="background-color:#ddffdd;"
| '''meleeMissAnimation'''
| Sprite ID from HIT.PCK played when this weapon misses a target with melee.
| -1
|- style="background-color:#ddffdd;"
| '''meleeMissAnimFrames'''
| Allows overriding number of frames for '''meleeMissAnimation'''.
| -1
|- style="background-color:#ddffdd;"
| '''psiAnimation'''
| Sprite ID from HIT.PCK played when this weapon hits a target with psi attack (only Panic/MindControl). For Use action on psi weapons, define hitAnimation.
| -1
|- style="background-color:#ddffdd;"
| '''psiAnimFrames'''
| Allows overriding number of frames for '''psiAnimation'''.
| -1
|- style="background-color:#ddffdd;"
| '''psiMissAnimation'''
| Sprite ID from HIT.PCK played when this weapon misses a target with psi attack (only Panic/MindControl). For Use action on psi weapons, define hitMissAnimation.
| -1
|- style="background-color:#ddffdd;"
| '''psiMissAnimFrames'''
| Allows overriding number of frames for '''psiMissAnimation'''.
| -1
|}

<div style="background:#ddffdd;">It can be pretty confusing, which sound/animation is played when... so here's an attempt to illustrate what happens. For each combination of "event" and "type of attack", there are multiple variables... the first variable that is not empty is used.
</div>

{| class="wikitable"
!  !! Bullets (non-explosive) !! Melee weapon (or gun-butt) !! Psi weapon (panic/MC) !! Psi weapon (Use)
|-
! Hit sound
| hitSound || meleeSound+meleeHitSound || psiSound > hitSound || hitSound
|-
! Miss sound
| - || meleeMissSound > meleeSound || psiMissSound > hitMissSound > psiSound > hitSound || hitMissSound > hitSound
|-
! Hit animation
| hitAnimation || meleeAnimation || psiAnimation > meleeAnimation || hitAnimation
|-
! Miss animation
| - || meleeMissAnimation > meleeAnimation || psiMissAnimation > meleeMissAnimation > psiAnimation > meleeAnimation || hitMissAnimation > hitAnimation
|}

==== Power and Damage types  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''power'''
| Weapon power. Usually corresponds to weapon's average damage. For some weapons/items, it determines the range (e.g. for incendiary or smoke).
| 0
|- style="background-color:#ddffdd;"
| '''ignoreAmmoPower'''
| Allows overriding ammo power and power bonuses by the firearm power and power bonuses.

More info: https://openxcom.org/forum/index.php?topic=12119.msg166913#msg166913
| false
|- style="background-color:#ddffdd;"
| '''powerForAnimation'''
| Weapon power used for area-of-effect explosion animation radius. Only used if greater than zero. Doesn't affect any damage calculations, purely visual.

More info: https://openxcom.org/forum/index.php/topic,10308.0.html
| 0
|- style="background-color:#ddffdd;"
| '''hidePower'''
| Allows hiding the weapon's power (and the entire ammo section) in the Ufopedia.

Note: this can be used for example when the weapon is mostly scripted and the damage info is more confusing than helpful.
| false
|-
| '''damageType'''
| What type of [[damage]] does this weapon do:
* 0 - None
* 1 - Armor Piercing
* 2 - Incendiary
* 3 - High Explosive
* 4 - Laser
* 5 - Plasma
* 6 - Stun
* 7 - Melee
* 8 - Acid
* 9 - Smoke
Notes:
* A damage type other than 0-9 will do nothing in OpenXcom.
* <span style="background:#ddffdd;">In OXCE, there are '''10 more damage types''' (10-19), which have same default settings as AP/Laser/Plasma/Acid damage types in OpenXcom.</span>
| 0
|-
| '''blastRadius'''
| Size of the projectile explosions. 0 for no explosion. -1 to automatically calculate based on weapon power and damage type (actual '''blastRadius''' currently is capped due [[Explosions#Playing_With_Fire|Explosion calculations]]).

<span style="background:#ddffdd;">Note: blastRadius is deprecated in OXCE. Use '''damageAlter.FixRadius''' instead. If both are specified, FixRadius is taken.</span>
| -1
|- style="background-color:#ddffdd;"
| '''damageAlter'''
| OpenXcom has 10 damage types and the mechanics of all 10 of them are completely hardcoded. In OXCE, you can use one of these hardcoded damage types as a starting point, but still be able to override all damage aspects for every item. To do this, you always use a pair of attributes for default and override:
* for normal/primary damage: default is in '''damageType''' and overrides in '''damageAlter'''
* for secondary melee damage: default is in '''meleeType''' and overrides in '''meleeAlter'''
Damage override has many attributes, which are all described in [[#Item Damage Types|Item Damage Types]].

Small example:

  - type: STR_HWP_DISC_PLASMA_CANNON
    damageType: 5
    damageAlter:
      RandomType: 6
      IgnoreOverKill: false
      ToArmorPre: 0.05
      ToStun: 0.75
      RandomWound: false
      ToWound: 0.12
      FireThreshold: 25

| -
|-
| '''meleePower'''
| Damage this weapon will do when using melee. This only applies to Firearms, and is only available as stun damage. For normal melee weapons, use regular power and damage types.
| 0
|- style="background-color:#ddffdd;"
| '''meleeType'''
| Default damage type for secondary melee attack. Automatically set to damage type 7 (melee) for items with '''battleType''' = 3 (melee weapon).
| -
|- style="background-color:#ddffdd;"
| '''meleeAlter'''
| Damage type details for '''meleeType'''.

Damage override has many attributes, which are all described in [[#Item Damage Types|Item Damage Types]].
| -
|-
| '''strengthApplied'''
| Add the attacking unit's strength to this weapon's damage.

<span style="background:#ddffdd;">Note: strengthApplied is deprecated in OXCE. Use '''damageBonus''' instead, which is also more configurable. If both are specified, damageBonus is taken.</span>
| false
|- style="background-color:#ddffdd;"
| '''damageBonus'''
| Formulae for additional weapon power bonus (not damage bonus!). Defined as a sum of polynomials of up to third degree with various unit stats as parameters :) If you didn't understand the previous sentence, don't be sad, just look at an example. '''FIXME''': add more description and examples later.

Example:

  - type: STR_EXAMPLE_1
    damageBonus:
      bravery: 2.5
      flatHundred: -1.25
  - type: STR_EXAMPLE_2
    damageBonus:
      firing: [0.0, 0.01]

In the first example the power bonus is "250% of soldier's bravery minus 125".

In the second example the power bonus is "0% of firing accuracy plus 1% of firing accuracy squared".
| -
|- style="background-color:#ddffdd;"
| '''meleeBonus'''
| Same as '''damageBonus''', but applies to secondary melee attacks.
| -
|}

==== Accuracy  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''noLOSAccuracyPenalty'''
| The penalty (in percent) to accuracy applied when attacking a unit or a tile outside of LOS. Overrides global setting.
| -1
|-
| '''accuracyAimed'''<br/>'''accuracySnap'''<br/>'''accuracyAuto'''<br/>'''accuracyMelee'''
| The base accuracy (in percent) applied to a soldier's [[Firing Accuracy]] when firing an Aimed/Snap/Auto shot or doing a Melee attack.

<span style="background:#ddffdd;">Note: in OXCE, it doesn't need to be applied only to firing accuracy, a combination of many other attributes can be used instead, see '''accuracyMultiplier''' and '''meleeMultiplier'''.</span>
| 0<br/>0<br/>0<br/>0
|- style="background-color:#ddffdd;"
| '''accuracyPanic'''<br/>'''accuracyMindControl'''<br/>'''accuracyUse'''
| The accuracy bonus (in flat percent) applied during psi attacks (Panic/MindControl/Use). '''accuracyMultiplier''' is also used in the calculations.
| 20<br/>0<br/>0
|- style="background-color:#ddffdd;"
| '''accuracyThrow'''
| The base accuracy (in percent) applied when throwing items. See also '''throwMultiplier'''.
| 100
|- style="background-color:#ddffdd;"
| '''accuracyCloseQuarters'''
| The base accuracy (in percent) applied when checking CQC (close quarters combat) score. Overrides global setting. See also '''closeQuartersMultiplier'''.
| -1
|- style="background-color:#ddffdd;"
| '''blockBothHands'''
| Does this weapon block both hands? If true, you '''cannot''' use this weapon while holding anything in the offhand.
| false
|-
| '''twoHanded'''
| Is this weapon two-handed? If true, incurs an accuracy penalty if used with both hands occupied. Note that the handsprite of a twoHanded item is also drawn at a slightly different position than a one handed item.
| false
|- style="background-color:#ddffdd;"
| '''oneHandedPenalty'''
| Override for the global one-handed penalty (which applies only to weapons marked as '''twoHanded'''). 20% penalty would be encoded as "80" (i.e. 100 minus 20), meaning you will use the weapon at 80% of its usual accuracy.
| -1
|- style="background-color:#ddffdd;"
| '''kneelBonus'''
| Override for the global kneel bonus (which applies to all weapons). 15% bonus would be encoded as "115" (i.e. 100 + 15), meaning you will use the weapon at 115% of its usual accuracy.
| -1
|-
| '''skillApplied'''
| Is melee accuracy skill applied to the accuracy of an attack made with this item? Only affects melee attacks.

<span style="background:#ddffdd;">Note: skillApplied is deprecated in OXCE. Use '''meleeMultiplier''' instead, which is also more configurable. If both are specified, meleeMultiplier is taken.</span>
| true
|- style="background-color:#ddffdd;"
| '''accuracyMultiplier'''
| Formulae defining the skills (i.e. various units stats) affecting the unit's accuracy when using this item in Aimed/Snap/Auto shots and in Psi attacks (Panic/MindControl/Use).

Example:

  - type: STR_EXAMPLE
    accuracyMultiplier:
      firing: 0.0
      throwing: 0.5
      melee: 0.5

In this example, the accuracy is based on 50% of unit's throwing skill and 50% of unit's melee skill... and 0% of unit's firing skill.
| -
|- style="background-color:#ddffdd;"
| '''meleeMultiplier'''
| Same as '''accuracyMultiplier''', but used for Melee attacks (primary and secondary).
| -
|- style="background-color:#ddffdd;"
| '''throwMultiplier'''
| Same as '''accuracyMultiplier''', but used for Throwing.
| -
|- style="background-color:#ddffdd;"
| '''closeQuartersMultiplier'''
| Same as '''accuracyMultiplier''', but used for CQC scoring.
| -
|}

==== Waypoints, Shotguns, Range Limits and Accuracy/Power Dropoff  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| 0
|- style="background-color:#ddffdd;"
| '''sprayWaypoints'''
| Waypoints for "spray shots", i.e. autoshots in multiple directions.

More info here: https://openxcom.org/forum/index.php/topic,6423.0.html
| 0
|-
| '''shotgunPellets'''
| Number of projectiles fired per unit of ammunition. (note: due to engine limitations it is currently impossible to draw multiple projectiles in flight.)
| 0
|- style="background-color:#ddffdd;"
| '''shotgunBehavior'''<br/>'''shotgunSpread'''<br/>'''shotgunChoke'''
| Attributes affecting how shotguns work.

More info: https://openxcom.org/forum/index.php/topic,4834.0.html
| 0<br/>100<br/>100
|-
| '''maxRange'''
| Maximum range at which this weapon can operate.
| 200
|-
| '''aimRange'''
| Maximum effective range with this weapon before which range-based dropoff occurs.
| 200
|-
| '''snapRange'''
| Maximum effective range with snap shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 15
|-
| '''autoRange'''
| Maximum effective range with auto shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 7
|-
| '''minRange'''
| Range-based dropoff will work in reverse for ranges below this.
| 0
|-
| '''dropoff'''
| The value by which the accuracy lowers for each tile after (or before) the thresholds above. The default for BT_PSIAMP is 1.
| 2
|- style="background-color:#ddffdd;"
| '''powerRangeThreshold'''
| Number of tiles defining the effective range (i.e. range with no power reduction). Beyond this range power reduction is applied.
| 0
|- style="background-color:#ddffdd;"
| '''powerRangeReduction'''
| Weapon's power dropoff per tile beyond effective range.
| 0
|- style="background-color:#ddffdd;"
| '''throwRange'''
| Maximum land/surface throwing range (can of course be less if you're weak).

More info: https://openxcom.org/forum/index.php/topic,8273.msg132698.html#msg132698
| 200
|- style="background-color:#ddffdd;"
| '''underwaterThrowRange'''
| Maximum underwater throwing range (can of course be less if you're weak).
| 200
|- style="background-color:#ddffdd;"
| '''throwDropoffRange'''
| Maximum effective throw range before which range-based dropoff occurs. (ufoextender accuracy only)

More info: https://openxcom.org/forum/index.php?topic=12203.msg171640#msg171640
| 99
|- style="background-color:#ddffdd;"
| '''underwaterThrowDropoffRange'''
| Maximum effective underwater throw range before which range-based dropoff occurs. (ufoextender accuracy only)
| 99
|- style="background-color:#ddffdd;"
| '''throwDropoff'''
| The value by which the throwing accuracy lowers for each tile after the thresholds above.
| 5
|}

==== Compatible ammo and Action Mapping  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''vehicleFixedAmmoSlot'''
| Allows to define a HWP without fixed ammo. Possible values: 0 and -1.

More info: https://openxcom.org/forum/index.php?topic=11843.msg165667#msg165667
| 0
|-
| '''clipSize'''
| The amount of ammo stored in each weapon clip. If -1 is specified, this weapon has infinite ammo. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon. Use clipsize -1 for melee weapons.
| 0
|-
| '''compatibleAmmo'''
| List of string IDs of the ammo items that can be loaded on this weapon. If none are specified, the weapon doesn't need ammo.
| -
|- style="background-color:#ddffdd;"
| '''tuLoad'''<br/>'''tuUnload'''
| Amount of [[Time Units]] required to load/unload this item.

'''Note''': in OXCE, when loading a weapon, you need to '''additionally''' pay the cost of moving the ammo from its current inventory slot into a hand slot! Consider that when balancing reload costs.

'''Update''': since OXCE v6.2, the OXCE behavior is now turned off by default. It can be enabled using the '''extendedItemReloadCost''' setting.
| 15<br/>8
|- style="background-color:#ddffdd;"
| '''ammo'''
| In OXCE, you can load multiple '''different''' types of ammo into one gun at the same time. This allows you to create, for example, a rifle with a built-in grenade launcher. There are up to 4 ammo slots, which can be assigned to Aimed/Snap/Auto actions. Going back to the rifle with a grenade launcher example, you could have the rifle with Aimed and Snap and sacrifice the Auto action for implementing let's say a Snap shot for the grenade launcher.

Example:

  - type: STR_WEAPON_WITH_4_AMMO_SLOTS
    ammo:
      0:
        compatibleAmmo: [ STR_AMMO_1, STR_AMMO_2 ]
        tuLoad: 5
        tuUnload: 2
      1:
        compatibleAmmo: [ STR_AMMO_3 ]
        tuLoad: 10
        tuUnload: 4
      2:
        compatibleAmmo: [ STR_AMMO_4, STR_AMMO_5 ]
        tuLoad: 10
        tuUnload: 4
      3:
        compatibleAmmo: [ STR_GRENADE_AMMO ]
        tuLoad: 20
        tuUnload: 8

| -
|-
| '''autoShots'''
| How many auto shots does this weapon fire.
| 3
|-
| '''arcingShot'''
| Does this weapon fire in an arc?
| false
|- style="background-color:#ddffdd;"
| '''confAimed'''<br/>'''confSnap'''<br/>'''confAuto'''<br/>'''confMelee'''
| A mapping between actions and ammo slots (see above).

Example 1:

  - type: STR_RIFLE_WITH_A_GRENADE_LAUNCHER
    confAimed:
      shots: 1
      followProjectiles: true    # default
      name: STR_AIMED_SHOT
      ammoSlot: 0
      arcing: false
    confSnap:
      shots: 2
      followProjectiles: false   # the camera stays still while shooting (prevents minigun seizures)
      name: STR_DOUBLE_SNAP_SHOT
      ammoSlot: 0
      arcing: false
    confAuto:
      shots: 1
      name: STR_LAUNCH_GRENADE
      ammoSlot: 3
      arcing: true
    confMelee:
      name: STR_PUNCH_IN_THE_FACE

Example 2: Battery-powered weapons: https://openxcom.org/forum/index.php/topic,9293.0.html

  - type: STR_LASGUN
    compatibleAmmo: [STR_LASGUN_CLIP]
    confAimed:
      spendPerShot: 4        # 4x battery consumption for 2x power
      name: STR_BIG_BOOM
    confSnap:
      name: STR_SMALL_BOOM
    tags:
      BPL_AIMED_2X_POWER: 1  # custom script

Example 3: Custom names and custom short names: https://openxcom.org/forum/index.php/topic,9742.msg143229.html#msg143229

 items:
   - type: STR_RIFLE
     confAimed:
       shots: 4
       name: STR_BIG_BOOM
       shortName: STR_BIG_BOOM_SHORT
     confSnap:
       name: STR_SMALL_BOOM
       shortName: STR_SMALL_BOOM_SHORT
     confAuto:
       shots: 2
       name: STR_SMALL_BOOM_X2
       shortName: STR_SMALL_BOOM_X2_SHORT

 extraStrings:
   - type: en-US
     strings:
       STR_BIG_BOOM: "Big boom"
       STR_BIG_BOOM_SHORT: "Big (x{0})"
       STR_SMALL_BOOM: "Small boom"
       STR_SMALL_BOOM_SHORT: "Small"
       STR_SMALL_BOOM_X2: "Double boom"
       STR_SMALL_BOOM_X2_SHORT: "Small (x{0})"

Example 4: Various probabilities overridden by shot type/action: https://openxcom.org/forum/index.php?topic=12537.msg170617#msg170617

 items:
   - type: STR_PISTOL
     confAimed:
       ammoZombieUnitChanceOverride: 10
       ammoSpawnUnitChanceOverride: 20
       ammoSpawnItemChanceOverride: 30

| -
|- style="background-color:#ddffdd;"
| '''psiAttackName'''
| Besides panic attack and mind control, weapons of psi-amp type can have also a third type of attack, bound to "use" attributes (for example '''costUse'''). This attribute defines what should be the name of such attack in the action menu (e.g. Seduce, VooDoo spell, etc.).

Note: also allows to rename motion scanner and mind probe use actions.
| -
|- style="background-color:#ddffdd;"
| '''primeActionName'''
| Name of the prime action in the action menu. Default is STR_PRIME_GRENADE.

Tip: in OXCE more item battleTypes can be primed than in OpenXcom, for example also battleType 10 (Electro-flares).
| <=
|- style="background-color:#ddffdd;"
| '''primeActionMessage'''
| Message for the player informing about the priming of an item. Default is STR_GRENADE_IS_ACTIVATED.
| <=
|- style="background-color:#ddffdd;"
| '''unprimeActionName'''
| Name of the un-prime action in the action menu.
| -
|- style="background-color:#ddffdd;"
| '''unprimeActionMessage'''
| Message for the player informing about the un-priming of an item. Default is STR_GRENADE_IS_DEACTIVATED.
| <=
|}

==== Cost of use  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''tuAimed'''<br/>'''tuSnap'''<br/>'''tuAuto'''<br/>'''tuMelee'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Aimed/Snap/Auto Shot or doing a Melee attack. If 0, the weapon does not have the corresponding attack.
| 0<br/>0<br/>0<br/>0
|-
| '''tuUse'''
| Amount of [[Time Units]] required to use this item (for non-offensive items). It's a flat rate if '''flatRate''' is true, otherwise it's a percentage (0-100%).
| 0
|- style="background-color:#ddffdd;"
| '''tuMindControl'''<br/>'''tuPanic'''
| Amount of [[Time Units]] required to use this item. If not specified, defaults to '''tuUse'''.
| -1<br/>-1
|- style="background-color:#ddffdd;"
| '''tuThrow'''<br/>'''tuPrime'''<br/>'''tuUnprime'''
| Amount of [[Time Units]] required to throw/prime/unprime this item.
| 25<br/>50<br/>25
|- style="background-color:#ddffdd;"
| '''costAimed'''<br/>'''costSnap'''<br/>'''costAuto'''<br/>'''costMelee'''<br/>'''costUse'''<br/>'''costMindControl'''<br/>'''costPanic'''<br/>'''costThrow'''<br/>'''costPrime'''<br/>'''costUnprime'''
| Extended way of defining the cost of item use. Instead of spending only time units, you can also define to spend energy, morale, HP, mana and stun. All costXXX settings override tuXXX settings, for example costAimed overrides tuAimed, etc.

Example:

  - type: STR_FUNNY_WEAPON
    costAimed:
      time: 90
      energy: 20
      morale: 65
      mana: 5

| -
|-
| '''flatRate'''
| If true, then TU costs for this weapon are a flat rate (instead of a percentage of unit TUs).
| false
|- style="background-color:#ddffdd;"
| '''flatAimed'''<br/>'''flatSnap'''<br/>'''flatAuto'''<br/>'''flatMelee'''<br/>'''flatUse'''<br/>'''flatThrow'''<br/>'''flatPrime'''<br/>'''flatUnprime'''
| Extended way of defining if the cost of item use is flat or in percentage. You can now define it for various actions separately. If defined, the more specific setting (e.g. flatAimed) overrides the less specific setting (flatRate).

Example:

  - type: STR_FUNNY_WEAPON
    costAimed:
      time: 90
      energy: 20
      mana: 5
    flatAimed:
      time: false   # 90% of TU
      energy: true  # 20 energy (flat)
      mana: true    # 5 mana (flat)

| -
|}

==== Debriefing/Recovery  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''experienceTrainingMode'''
| Defines which skill(s) should improve when the soldiers gain experience by hitting enemy units (or healing fatal wounds of any units; or performing psi attacks).

More info: https://openxcom.org/forum/index.php/topic,4230.0.html
| 0
|- style="background-color:#ddffdd;"
| '''manaExperience'''
| How much mana experience points does the weapon provide. Since OXCE v6.6, this attribute also works on psi-amps (also on unsuccessful attempts).

  manaExperience: 250    # this means 2 points + 50% chance for a 3rd point (on every hit on hostile unit)
| 0
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|- style="background-color:#ddffdd;"
| '''recoverCorpse'''
| Since the '''recover''' flag applies to both live body (prisoner capture) and dead body (corpse recovery) in OpenXcom, OXCE adds this new flag to allow recovery of a live body, but disable recovery of the corpse (used in mods mostly to ignore dead bodies of killed humans).
| true
|-
| '''recoveryPoints'''
| [[Score]] gained for recovering this alien artifact.
| 0
|-
| '''liveAlien'''
| Does this item represent a live alien? (counts towards [[Alien Containment]])
| false
|- style="background-color:#ddffdd;"
| '''prisonType'''
| What type of prison (alien containment) facility can accommodate a unit (marked as '''liveAlien''') represented by this item.

More info: https://openxcom.org/forum/index.php/topic,4830.msg69933.html#msg69933 
| 0
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.

<span style="background:#ddffdd;">Note: in OXCE, '''specialType''' >= 200 are reserved for death traps, so please don't use them. More info: https://openxcom.org/forum/index.php/topic,7671.msg132978.html#msg132978</span>
| -1
|- style="background-color:#ddffdd;"
| '''recoveryDividers'''
| Definition how special items (with '''specialType''' > 1 and '''specialType''' < 200) should be recovered from the mission.

More info here: https://openxcom.org/forum/index.php/topic,6616.0.html

Note: since OXCE v7.2 also negative values can be used and will be treated as multipliers, not dividers: https://openxcom.org/forum/index.php/topic,6616.msg142693.html#msg142693
| -
|- style="background-color:#ddffdd;"
| '''recoveryTransformations'''
| Allows recovering items as other items (for example alien weapons as alien weapon fragments).

More info here: https://openxcom.org/forum/index.php/topic,6868.0.html
| -
|}

==== Medikits  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''medikitActionName'''
| Name of the use action in the action menu. Default is STR_USE_MEDI_KIT.
| <=
|- style="background-color:#ddffdd;"
| '''painKillerActionName'''
| Name of the painkiller action displayed on medikit UI. Default is STR_PAIN_KILLER.
| <=
|- style="background-color:#ddffdd;"
| '''stimulantActionName'''
| Name of the stimulant action displayed on medikit UI. Default is STR_STIMULANT.
| <=
|- style="background-color:#ddffdd;"
| '''healActionName'''
| Name of the heal action displayed on medikit UI. Default is STR_HEAL.
| <=
|- style="background-color:#ddffdd;"
| '''medikitType'''
| Defines, which functions can this medikit perform. Possible options:
* 0 = All functions
* 1 = Heal only
* 2 = Stimulant only
* 3 = Painkiller only
| 0
|- style="background-color:#ddffdd;"
| '''medikitTargetSelf'''
| Is it possible to use the medikit on oneself (true)? Or only on other units (false)? Ignores other settings.
| false
|- style="background-color:#ddffdd;"
| '''medikitTargetImmune'''
| Is it possible to use the medikit on units that cannot bleed (true)? Or only on other units (false)?
| false
|- style="background-color:#ddffdd;"
| '''medikitTargetMatrix'''
| Says what targets are allowed for a medikit item. It is a composite attribute (a bit map), individual parts:
* 1 = friendly on the ground
* 2 = friendly standing
* 4 = neutral on the ground
* 8 = neutral standing
* 16 = hostile on the ground
* 32 = hostile standing

So, for example:
* 0 = cannot use on anyone
* 3 (1+2) = can use only on friendlies
* 31 (1+2+4+8+16) =  can use on everyone except on standing hostiles/enemies
* 63 = can use on everyone
* etc.
| 63
|- style="background-color:#ddffdd;"
| '''isConsumable'''
| Will this medikit be automatically refilled at the base (false)? Or will it disappear after the mission, if used at least once (true)?

Note: If you use multiple medikits, they will use the same "combination" algorithm as the guns use for bullet recovery in OpenXcom. Using two medikits let's say just once will not make both of them disappear, because there will be enough "stuff" left to fully recover one of them.
| false
|-
| '''painKiller'''
| Amount of painkillers contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''heal'''
| Amount of heals contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stimulant'''
| Amount of stimulants contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''woundRecovery'''
| Amount of [[Fatal Wounds]] treated by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''healthRecovery'''
| Amount of [[Health]] recovered by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stunRecovery'''
| Amount of [[Stun]] removed by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''energyRecovery'''
| Amount of [[Energy]] recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|- style="background-color:#ddffdd;"
| '''manaRecovery'''
| Amount of Mana recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|- style="background-color:#ddffdd;"
| '''painKillerRecovery'''
| Strength of the pain killers (1.0 = 100%). Linear factor affecting vanilla morale recovery (based on lost health).
| 1.0
|- style="background-color:#ddffdd;"
| '''moraleRecovery'''
| Additional points of morale to restore when pain killers are used. Does not depend on lost health (or anything else).
| 0
|- style="background-color:#ddffdd;"
| '''medikitBackground'''
| Sprite ID of the medikit background.

Tip: size and position of buttons can also be adjusted using Interface ruleset (but only globally for all medikit items).
| -
|}

==== Inventory  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''weight'''
| [[Item_Weight|Weight]] occupied by this item in a soldier's inventory.
| 3
|-
| '''invWidth'''
| Item width in a soldier's inventory (in grid units).
| 1
|-
| '''invHeight'''
| Item height in a soldier's inventory (in grid units).
| 1
|- style="background-color:#ddffdd;"
| '''inventoryMoveCost'''
| Cost of moving item between slots. Does not apply to dropping items from hands.
 inventoryMoveCost:
   basePercent: 100 #TU multiplier of base cost
| 100
|-
| '''fixedWeapon'''
| Is this weapon fixed (cannot be dropped from the Inventory)? (it's part of a unit, e.g. tanks and terrorist units)
| false
|- style="background-color:#ddffdd;"
| '''fixedWeaponShow'''
| Should the fixed weapon be drawn on the unit in the Battlescape or not? Normally, the weapon is not drawn (for example Reaper or Cyberdisc weapon... because it's a part of the unit itself), but in mods you may have for example fixed weapons on certain armors, which you want to display as normal "carried" weapons.
| false
|- style="background-color:#ddffdd;"
| '''defaultInventorySlot'''
| An inventory slot where a '''fixedWeapon''' should be placed when it is created.
| -
|- style="background-color:#ddffdd;"
| '''defaultInvSlotX'''
| A position within the inventory slot where a '''fixedWeapon''' should be placed when it is created.
| 0
|- style="background-color:#ddffdd;"
| '''defaultInvSlotY'''
| A position within the inventory slot where a '''fixedWeapon''' should be placed when it is created.
| 0
|- style="background-color:#ddffdd;"
| '''supportedInventorySections'''
| A list of inventory slots, where this item can be (manually) placed. If empty, all slots are OK.
| -
|-
| '''ignoreInBaseDefense'''
| Items marked with this flag will not appear in the Base Defense mission.

Note: mods, which have items used mostly in Geoscape (e.g. random resources used for manufacturing), but still recoverable from Battlescape should use this flag so that the ground inventory is not spammed by useless junk slowing the game down (significantly! if there are thousands of such items).
| false
|- style="background-color:#ddffdd;"
| '''ignoreInCraftEquip'''
| Items marked with this flag will not appear in Craft Inventory Equipment screen.
Defaults:
* true for corpses (battleType=11) and geoscape-only items (battleType=0)
* false for all other items
| <=
|- style="background-color:#ddffdd;"
| '''specialUseEmptyHand'''
| Whether this '''specialWeapon''' is used when clicking on the empty hand slot in soldier's inventory. Used for punching/kicking with bare hands :)
| false
|- style="background-color:#ddffdd;"
| '''specialUseEmptyHandShow'''
| If true, the sprite of the special weapon will be shown in the empty hand UI (similar to what was done in OXC in April 2020). '''specialUseEmptyHand''' must be true too.
| false
|}

==== Things that go BOOM  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''fuseType'''
| Defines how item priming works.

Possible options:
* -3 No priming. Flares always glow if '''defaultBehavior''' is true.
* -2 Can be primed (without timer). Proxies work normally. Grenades explode instantly after throwing. Flares glow only after priming.
* -1 Can be primed (for manually specified amount of turns). Grenades explode after set time. Proxies and flares disappear after set time.
* 0-63 Can be primed (for fixed amount of turns).

Defaults:
* -2 for proximity grenades
* -1 for grenades
* -3 for everything else
| <=
|- style="background-color:#ddffdd;"
| '''fuseTriggerEvents'''
| Defines how fuse triggers work. Contains 5 sub-attributes:

* '''defaultBehavior''': everything works as in vanilla
* '''throwTrigger''': timer starts only after throwing
* '''throwExplode''': items explode (grenades) or are removed (other) on throw; affected by '''specialChance'''
* '''proximityTrigger''': timer starts only after moving into item's proximity
* '''proximityExplode''': item explode (grenades, proxies) or are removed (other) after moving into item's proximity; affected by '''specialChance'''

Example/Defaults:

  fuseTriggerEvents:
    defaultBehavior: true
    throwTrigger: false
    throwExplode: false
    proximityTrigger: false
    proximityExplode: false

| <=
|- style="background-color:#ddffdd;"
| '''specialChance'''
| The chance (0-100%) of special effects happening, including:
* mine triggering (see above)
* corpse explosion (e.g. of a bio-drone corpse)
* zombification (e.g. by a chryssalid weapon), see also '''zombieUnitChance'''
* unit spawning (e.g. by a brainsucker launcher), see also '''spawnUnitChance'''
* item spawning (e.g. by a flare launcher), see also '''spawnItemChance'''
| 100
|- style="color:#666666;"
| '''isExplodingInHands'''
| ''Deprecated:'' use '''explodeInventory''' instead.

Will be completely removed in 2026.
| false
|- style="background-color:#ddffdd;"
| '''explodeInventory'''
| How should primed items in the inventory behave?

* -1 = use global setting '''explodeInventoryGlobal''' (default)
* 0 = doesn't explode in inventory
* 1 = explodes in inventory, except in hands
* 2 = explodes in inventory

More info: https://openxcom.org/forum/index.php?topic=12421.msg171340#msg171340
| -1
|- style="background-color:#ddffdd;"
| '''hiddenOnMinimap'''
| Is the item visible on the minimap?

Tip: use for example for mines hidden underground
| false
|}

==== Spawning  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''zombieUnit'''
| String ID of the unit used for zombification (eg. [[Chrysallid]]s turn units into [[Zombie]]s).
| -
|- style="background-color:#ddffdd;"
| '''zombieUnitFaction'''<br/>'''zombieUnitChance'''
| Affects zombification result.

More info: https://openxcom.org/forum/index.php/topic,11241.0.html
| -<br/>-1
|- style="background-color:#ddffdd;"
| '''zombieUnitByArmorMale'''
| Overrides '''zombieUnit'''. Based on armor worn by the victim. A list of String ID pairs.
| -
|- style="background-color:#ddffdd;"
| '''zombieUnitByArmorFemale'''
| Overrides '''zombieUnit'''. Based on armor worn by the victim. A list of String ID pairs.
| -
|- style="background-color:#ddffdd;"
| '''zombieUnitByType'''
| Overrides '''zombieUnit'''. Based on the victim soldier/unit type. A list of String ID pairs.
| -
|- style="background-color:#ddffdd;"
| '''spawnUnit'''<br/>'''spawnUnitFaction'''<br/>'''spawnUnitChance'''
| Used for spawning units from items.

More info: https://openxcom.org/forum/index.php/topic,11241.0.html
| 
|- style="background-color:#ddffdd;"
| '''spawnItem'''<br/>'''spawnItemChance'''
| Used for spawning items from projectiles.

More info: https://openxcom.org/forum/index.php/topic,11241.0.html
| 
|}

==== Miscellaneous  ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''isFireExtinguisher'''
| Can this item be used to extinguish fire on units?
| false
|- style="background-color:#ddffdd;"
| '''isAmmoRechargeable'''
| Should the ammo clip disappear automatically when it reaches zero rounds (default) or should it remain (because a Y-script might refill it)?

More info: https://openxcom.org/forum/index.php?topic=12832.0
| false
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''attraction'''
| Represents how likely an alien is to pick up this item. Values below 5 will be ignored (by design).
| 0
|-
| '''LOSRequired'''
| Does this item require line of sight? (only applies to mind probes and psi-amps)
| false
|- style="background-color:#ddffdd;"
| '''psiRequired'''
| Does using this item require psi skill > 0 ? Items of battleType=9 (psi-amps) have this flag set to ''true'' by default.
| false
|- style="background-color:#ddffdd;"
| '''targetMatrix'''
| Says what targets are allowed for an item. It is a composite attribute (a bit map), individual parts:
* 1 = friendly
* 2 = hostile
* 4 = neutral

So, for example:
* 0 = cannot use on anyone
* 1 = can use only on friendlies
* 6 (2+4) = can use only on hostiles and neutrals
* etc.

Currently works only for '''psi-amps''' (default 6) and for '''death traps''' (default 7).

Note: Mind-controlling friendlies is never possible, hardcoded. Panicking friendlies is possible.
| 6 or 7
|- style="background-color:#ddffdd;"
| '''convertToCivilian'''
| Mind control a hostile unit into a civilian unit?
| false
|- style="background-color:#ddffdd;"
| '''manaRequired'''
| Does using this item require mana research unlocked?
| false
|-
| '''underwaterOnly'''
| Can this item only be used underwater?
| false
|-
| '''landOnly'''
| Can this item only be used on land?
| false
|- style="background-color:#ddffdd;"
| '''ai.useDelay'''<br/>'''ai.meleeHitCount'''
| 1/ Used to override AI delay defined by global settings.

2/ How many times should an AI unit try to perform a melee attack (in the single go)? In vanilla, the unit used the melee attack until the target was neutralized or until it ran out of TUs. This attribute gives you the option to perform "hit and run".

  ai:
    useDelay: 1
    meleeHitCount: 15

| -1<br/>25
|}

=== Item Categories ===

<span style="background:#ddffdd;">Defines some extra behavior (and list order) of item categories, listed in ''"itemCategories:"''.</span>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the item category name.
| ''required''
|- style="background-color:#ddffdd;"
| '''hidden'''
| Defines whether this category should be hidden in the filter on the [Craft Equipment] screen.

Note: categories not shown to the player are still useful for the modder sometimes.
| false
|- style="background-color:#ddffdd;"
| '''replaceBy'''
| Defines mapping between item categories.

Note: this is useful when you are still experimenting with the item categorization. If you defined too many categories for example, you can group them together easily here, instead of having to redefine all the items. And if you change your mind later, you can easily ungroup them again.
| -
|- style="background-color:#ddffdd;"
| '''invOrder'''
| Ordered list of inventory slots to be used for auto-equip/quick-equip preferences.

More info here: https://openxcom.org/forum/index.php?topic=7868.msg161832#msg161832
| -
|}

=== Weapon Sets ===

<span style="background:#ddffdd;">Defines sets of items/weapons, listed in ''"weaponSets:"''. More info here: https://openxcom.org/forum/index.php?topic=12065.0</span>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the weapon set name.
| ''required''
|- style="background-color:#ddffdd;"
| '''weapons'''
| List of weapons in the weapon set.

Note: currently only used within '''weightedBuiltInWeaponSets'''.
| -
|}

=== Item Damage Types ===

<span style="background:#ddffdd;">These are the sub-attributes you can use within attributes '''damageAlter''' and '''meleeAlter'''. Listed separately for convenience.</span>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''FixRadius'''
| A blast radius.
* -1 = dynamic blast radius
* 0 = no blast radius
* 1+ = fixed blast radius
| 0
|- style="background-color:#ddffdd;"
| '''RandomType'''
| Defines how will the dice be rolled to determine the damage based on power (primary damage calculation).

Possible options ('''until OXCE 7.1'''):
* 0 = default OpenXcom behavior dependent on damageType (can be like 1, 2, 4 or 5) (affected by '''damageRange''' (1) and '''explosiveDamageRange''' (2))
* 1 = hardcoded 0-200% spread ('''NOT''' affected by '''damageRange''')
* 2 = hardcoded 50-150% spread ('''NOT''' affected by '''explosiveDamageRange''')
* 3 = flat damage equal to power
* 4 = random damage in range defined by '''fireDamageRange'''
* 5 = no damage
* 6 = 0-200% spread (2 dice roll), i.e. 0-100% + 0-100%
* 7 = 50-200% spread

Possible options ('''since OXCE 7.1'''):
* 0 = behavior dependent on damageType (can be 8, 9, 4 or 5)
* 1 = hardcoded 0-200% spread ('''NOT''' affected by '''damageRange''')
* 2 = hardcoded 50-150% spread ('''NOT''' affected by '''explosiveDamageRange''')
* 3 = flat damage equal to power
* 4 = random damage in range defined by '''fireDamageRange'''
* 5 = no damage
* 6 = 0-200% spread (2 dice roll), i.e. 0-100% + 0-100%
* 7 = 50-200% spread
* 8 = standard = 0-200% spread (affected by '''damageRange''')
* 9 = explosion = 50-150% spread (affected by '''explosiveDamageRange''')
| 8
|- style="background-color:#ddffdd;"
| '''ResistType'''
| A damage type, i.e. what resistance of the target unit's armor is applied. Same values like '''damageType'''.
| 0
|- style="background-color:#ddffdd;"
| '''FireBlastCalc'''
| Vanilla fire/incendiary blast radius has a special formula. This option turns it on/off.
| false
|- style="background-color:#ddffdd;"
| '''IgnoreDirection'''
| Should the damage calculation ignore from which direction the projectile came? Uses front armor for damage calculation. Used for example for smoke or fire.
| false
|- style="background-color:#ddffdd;"
| '''IgnoreSelfDestruct'''
| Killing using this damage prevents self-destruct (e.g. of Cyberdisc). Used for example on HE, Stun or Melee damage.
| false
|- style="background-color:#ddffdd;"
| '''IgnorePainImmunity'''
| Some units are immune to pain/stun (see '''painImmune''' on Armor). This allows you to ignore such immunity. Used for example on Stun damage.
| false
|- style="background-color:#ddffdd;"
| '''IgnoreNormalMoraleLose'''
| When units are hit, they lose morale. This option allows you to turn this effect on/off.
| false
|- style="background-color:#ddffdd;"
| '''IgnoreOverKill'''
| Disables overkill damage, i.e. units won't get vaporized/disintegrated when killed (by a hit doing a lot more damage than necessary to kill).
| true
|- style="background-color:#ddffdd;"
| '''ArmorEffectiveness'''
| How effective is a unit's front/side/rear/bottom armor against this damage. 1.0 is 100%.
| 1.0
|- style="background-color:#ddffdd;"
| '''RadiusEffectiveness'''
| If FixRadius = -1, the blast radius is not fixed, but dynamically calculated from Power (incl. Power bonus). This is a factor for such calculation.
| 0.0
|- style="background-color:#ddffdd;"
| '''RadiusReduction'''
| How much explosion Power decreases with distance from the center.
| 10.0
|- style="background-color:#ddffdd;"
| '''FireThreshold'''
| How much damage is needed to set a unit or a tile on fire.
| 1000
|- style="background-color:#ddffdd;"
| '''SmokeThreshold'''
| How much damage is needed to create smoke on a tile.
| 1000
|- style="background-color:#ddffdd;"
| '''ToArmorPre'''
| How much of the primary damage (Power x RandomType) is applied to the unit's armor ''before'' armor is considered.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomArmorPre'''
| Should the calculation above be randomized?

Example 1: Power = 100. Primary damage rolled = for example 140. ToArmorPre = 0.1. RandomArmorPre = '''false'''. Damage applied to a unit's armor will be 14.

Example 2: Power = 100. Primary damage rolled = for example 140. ToArmorPre = 0.1. RandomArmorPre = '''true'''. Damage applied to a unit's armor will be a random value between 0 and 14.
| false
|- style="background-color:#ddffdd;"
| '''ToArmor'''
| How much of the primary damage is applied to the unit's armor ''after'' armor is considered.
| 0.1
|- style="background-color:#ddffdd;"
| '''RandomArmor'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToHealth'''
| How much of the primary damage is applied to the unit's health.
| 1.0
|- style="background-color:#ddffdd;"
| '''RandomHealth'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToStun'''
| How much of the primary damage is applied to the unit's stun level.
| 0.25
|- style="background-color:#ddffdd;"
| '''RandomStun'''
| Should the calculation above be randomized?
| true
|- style="background-color:#ddffdd;"
| '''ToWound'''
| How much of the primary damage is applied as fatal wounds.
| 1.0
|- style="background-color:#ddffdd;"
| '''RandomWound'''
| Alters the above calculation. Default settings equal to vanilla calculations. Formula is quite hard to describe in words, so here's the code:
  if (damage > 0) {
    if (RandomWound) {
      if (RNG::generate(0, 10) < int(damage * ToWound)) {
        return RNG::generate(1,3);
      }
    } else {
      return (int)std::round(damage * ToWound);
    }
  }

| true
|- style="background-color:#ddffdd;"
| '''ToTime'''
| How much of the primary damage is applied to the unit's TUs.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomTime'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToEnergy'''
| How much of the primary damage is applied to the unit's energy.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomEnergy'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToMana'''
| How much of the primary damage is applied to the unit's mana burn.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomMana'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToMorale'''
| How much of the primary damage is applied to the unit's morale.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomMorale'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToItem'''
| How much of the primary damage is applied to items.
| 0.0
|- style="background-color:#ddffdd;"
| '''RandomItem'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''ToTile'''
| How much of the primary damage is applied to the terrain.
| 0.5
|- style="background-color:#ddffdd;"
| '''RandomTile'''
| Should the calculation above be randomized?
| false
|- style="background-color:#ddffdd;"
| '''TileDamageMethod'''
|  Which tile damage method should be used?
* For AOE (area-of-effect) weapons:
** TileDamageMethod==1: (50%-150% * power * ToTile)
** TileDamageMethod==2: ((power x RandomTile) * ToTile), which defaults to vanilla 50% damage for HE and 0% for stun, smoke and incendiary
* For non-AOE (projectile) weapons:
** TileDamageMethod==1: (50%-150% * power * ToTile), which defaults to vanilla 25%-75% damage for AP/laser/plasma/etc.
** TileDamageMethod==2: ((damage x RandomTile) * ToTile)
| 1
|- style="background-color:#ddffdd;"
| '''TileDamageLimit'''
|  Limits the maximum tile damage possible regardless of Power, ToTile, RandomTile, TileDamageMethod, etc. A value of -1 means no limit.
| -1
|}

<div style="background:#ddffdd;">'''IMPORTANT''': The defaults above are the generic defaults. For each damage type, there are also specific defaults that emulate the vanilla hardcoded damage types. For modding purposes, the specific defaults are relevant (they override the generic ones). Below is the summary of the specific defaults.</div>

{| class="wikitable" width="100%"
!  !! DT_NONE !! DT_AP !! DT_IN !! DT_HE !! DT_LASER !! DT_PLASMA !! DT_STUN !! DT_MELEE !! DT_ACID !! DT_SMOKE !! DT_10 ... DT_19
|- style="background-color:#ddffdd;"
| RandomType || 5 || 8 || 4 || 9 || 8 || 8 || 8 || 8 || 8 || 5 || 8
|- style="background-color:#ddffdd;"
| ResistType ||  || 1 || 2 || 3 || 4 || 5 || 6 || 7 || 8 || 9 || 10 ... 19
|- style="background-color:#ddffdd;"
| FireBlastCalc ||  ||  || true ||  ||  ||  ||  ||  ||  ||  || 
|- style="background-color:#ddffdd;"
| IgnoreOverKill ||  || true || true || true || true || true || true || true || true || true || true
|- style="background-color:#ddffdd;"
| IgnoreSelfDestruct ||  ||  || true || true ||  ||  || true || true ||  ||  || 
|- style="background-color:#ddffdd;"
| IgnorePainImmunity ||  ||  ||  ||  ||  ||  || true ||  ||  ||  || 
|- style="background-color:#ddffdd;"
| IgnoreDirection ||  ||  || true ||  ||  ||  ||  ||  ||  || true || 
|- style="background-color:#ddffdd;"
| FixRadius ||  ||  || -1 || -1 ||  ||  || -1 ||  ||  || -1 || 
|- style="background-color:#ddffdd;"
| RadiusEffectiveness ||  ||  || 0.03 || 0.05 ||  ||  || 0.05 ||  ||  || 0.05 || 
|- style="background-color:#ddffdd;"
| ArmorEffectiveness ||  ||  || 0.0 ||  ||  ||  ||  ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| FireThreshold ||  ||  || 0 ||  ||  ||  ||  ||  ||  ||  || 
|- style="background-color:#ddffdd;"
| SmokeThreshold ||  ||  ||  ||  ||  ||  ||  ||  ||  || 0 || 
|- style="background-color:#ddffdd;"
| ToHealth ||  ||  || 1.0 ||  ||  ||  || 0.0 ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| ToArmor ||  ||  || 0.0 ||  ||  ||  || 0.0 ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| ToWound ||  ||  || 0.0 ||  ||  ||  || 0.0 ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| ToItem ||  ||  || 0.0 || 1.0 ||  ||  || 0.0 ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| ToTile ||  ||  || 0.0 ||  ||  ||  || 0.0 ||  ||  || 0.0 || 
|- style="background-color:#ddffdd;"
| ToStun ||  ||  || 0.0 ||  ||  ||  || 1.0 ||  ||  || 1.0 || 
|- style="background-color:#ddffdd;"
| RandomStun ||  ||  ||  ||  ||  ||  || false ||  ||  ||  || 
|- style="background-color:#ddffdd;"
| TileDamageMethod ||  ||  || 2 || 2 ||  ||  || 2 ||  ||  || 2 || 
|}

=== UFOs ===

Defines one of the [[UFOs]] that invade Earth, listed in ''"ufos:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the UFO name.
| ''required''
|-
| '''size'''
| String ID of the UFO size.
| STR_VERY_SMALL
|- style="background-color:#ddffdd;"
| '''radius'''
| UFO's radius. Not used. More info: https://openxcom.org/forum/index.php?topic=12372.msg169679#msg169679
| -1
|- style="background-color:#ddffdd;"
| '''visibility'''
| UFO's default visibility (not considering UFO's altitude yet). More info: https://openxcom.org/forum/index.php?topic=12372.msg169680#msg169680
| 0
|- style="background-color:#ddffdd;"
| '''blobSize'''
| UFO's size in Dogfight. Also UFO's size for calculations in Dogfight. More info: https://openxcom.org/forum/index.php?topic=12372.msg169681#msg169681
| -1
|-
| '''sprite'''
| Sprite ID from [[INTERWIN.DAT]] used to draw this UFO in the dogfight view and UFOpaedia.

Note: don't try to add more images if you don't want to punch yourself in the face - use '''modSprite''' instead.
| -1
|-
| '''modSprite'''
| Filename used to draw this UFO in the dogfight view and UFOpaedia.
| -
|-
| '''marker'''
| Sprite ID from GlobeMarkers spritesheet, used for drawing flying UFO icon on the globe. Usually 3x3 pixels, but can be modded to be bigger.

Note: if not modded, sprite id 2 is used (=vanilla flying UFO marker).
| -1
|-
| '''markerLand'''
| Sprite ID from GlobeMarkers spritesheet, used for drawing landed UFO icon on the globe. Usually 3x3 pixels, but can be modded to be bigger.

Note: if not modded, sprite id 3 is used (=vanilla landed UFO marker).
| -1
|-
| '''markerCrash'''
| Sprite ID from GlobeMarkers spritesheet, used for drawing crashed UFO icon on the globe. Usually 3x3 pixels, but can be modded to be bigger.

Note: if not modded, sprite id 4 is used (=vanilla crashed UFO marker).
| -1
|-
| '''power'''
| Damage power of this UFO's weapon in dogfights.
| 0
|-
| '''range'''
| Maximum range of this UFO's weapon in dogfights (in kilometers).
| 0
|-
| '''score'''
| [[Score]] gained when this UFO crash lands, double amount if it is destroyed.
| 0
|-
| '''reload'''
| Time the UFO's weapon takes to fire between each shot.
| 0
|-
| '''breakOffTime'''
| Minimum amount of time for the UFO to be able to break off of a dogfight. The equation is X + (0->X) - (30 * difficultyCoefficient). For example, if you set the breakOffTime to 100, then on Beginner (difficultyCoefficient: 0) you will get anywhere from 100 to 200 gs before retreat (which is a pretty small amount). But for the same value on Superhuman (difficultyCoefficient: 4), you will get 120 gs shorter time, which is anywhere from negative 20 to positive 80 gs, meaning there will be a 20% chance for the interception window to close immediately as soon as you engage the UFO. This is assuming vanilla difficultyCoefficient.
| 0
|-
| '''missionScore'''
| Negative points awarded each half hour the UFO is airborne, and twice this value when landed
| 1
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this UFO in Battlescape missions.
| ''required''
|- style="background-color:#ddffdd;"
| '''hunterKillerPercentage'''
| The chance (0-100%) to become a hunter-killer UFO upon spawning (unless overridden by mission wave).

Possible options:
*  0 = not a hunter-killer
*  1-99 = percentage chance to be flagged as hunter-killer upon spawn
*  100 = always a hunter-killer
| 0
|- style="background-color:#ddffdd;"
| '''huntMode'''
| Algorithm to use when prioritizing xcom targets (unless overridden by mission wave).

Possible options:
* 0 = prefer hunting xcom interceptors
* 1 = prefer hunting xcom transports
* 2 = random preference (0 or 1) determined at spawn
| 0
|- style="background-color:#ddffdd;"
| '''huntBehavior'''
| Algorithm to use when considering retreating from the dogfight (unless overridden by mission wave).

Possible options:
* 0 = flee if you're losing
* 1 = never flee, never crash (since OXCE v6.5, they fight until 0% HP, not 50% HP)
* 2 = random preference (0 or 1) determined at spawn
| 2
|- style="background-color:#ddffdd;"
| '''softlockThreshold'''
| When a hunter-killer UFO (which is faster than the player craft) fires this many times and still doesn't destroy the player craft, it disengages and stops hunting.
| 100
|- style="background-color:#ddffdd;"
| '''huntSpeed'''
| When hunter-killer finds a target, it will change speed to a percentage of its maximum speed.

Possible options:
* 0 = don't change speed, i.e. keep current speed
* 1-99 = set speed to a percentage of maximum speed
* 100 = speed up to maximum
* 100+ = yes, you can go beyond maximum speed... but only during the chase, when intercepted, the maximum speed will be correctly considered for all relevant calculations and game mechanics
| 100
|- style="background-color:#ddffdd;"
| '''missilePower'''
| Only relevant for retaliation UFOs. If not shot down during the base defense, it will destroy some base facilities or even the whole base (without ground mission!).

Possible options:
* -1 = destroy everything
* 0 = disabled (i.e. not a missile)
* N = destroy N 1x1 buildings or equivalent

More info: https://openxcom.org/forum/index.php/topic,6668.0.html
| 0
|- style="background-color:#ddffdd;"
| '''unmanned'''
| Unmanned UFOs (e.g. missiles, drones, etc.) cannot crash land after dogfight and cannot be forced to land by a tractor beam. They fight until 0% HP (not 50% HP).
| false
|- style="background-color:#ddffdd;"
| '''splashdownSurvivalChance'''
| Chance (in percent) for a UFO to survive a crash landing on "fake underwater" globe texture.
| 100
|- style="background-color:#ddffdd;"
| '''fakeWaterLandingChance'''
| Chance (in percent) for a UFO to land on "fake underwater" globe texture.
| 0
|- style="background-color:#ddffdd;"
| '''fireSound'''
| UFO's fire sound in the Dogfight, from GEO.CAT.
| -1
|- style="background-color:#ddffdd;"
| '''alertSound'''
| Sound played when this type of UFO is detected, from GEO.CAT.
| -1
|- style="background-color:#ddffdd;"
| '''huntAlertSound'''
| Sound played when this type of UFO starts hunting an XCOM craft, from GEO.CAT.
| -1
|- style="background-color:#ddffdd;"
| '''hitSound'''
| Sound played when this type of UFO damages/destroys an xcom base, from GEO.CAT.
| -1
|- style="background-color:#ddffdd;"
| '''hitImage'''
| Allows to override the background image of the base damaged/destroyed popup window.
| -
|- style="background-color:#ddffdd;"
| '''raceBonus'''
| Modifies or overrides the UFO Stats per alien race.

You can use this to make the same type of UFO have different [[#UFO Stats|stats]] depending on the alien race.

  - type: STR_TERROR_SHIP
    raceBonus:
      STR_MUTON:
        hitBonus: 20
        craftCustomDeploy: STR_MORE_SCARY_WEAPONS
        missionCustomDeploy: STR_TERROR_SITE_MUTONS
      STR_ETHEREAL:
        missionCustomDeploy: STR_END_OF_THE_WORLD

| -
|- style="background-color:#ddffdd;"
| '''instaHyper'''
| Display hyper-wave decoder info at base defense even if the UFO was not detected yet? https://openxcom.org/forum/index.php?topic=12524.msg170837#msg170837
| false
|}

==== UFO Stats ====

The following attributes define so called "ufo stats". They are listed in a separate table, just for convenience... but are still part of the UFO ruleset.

<span style="background:#ddffdd;">'''Note:''' In OXCE, all these stats are dynamic, i.e. can depend on the alien race piloting the UFOs.</span>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''damageMax'''
| Maximum amount of damage this UFO can take. If the UFO takes 50% damage, it crash lands. If it takes 100% damage, it is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles.
| 0
|- style="background-color:#ddffdd;"
| '''radarRange'''
| Detection range of the UFO's radar in nautical miles. Relevant for hunter-killer UFOs.
| 672
|- style="background-color:#ddffdd;"
| '''radarChance'''
| Unused.
| 0
|-
| '''sightRange'''
| UFO's sight range (for detecting X-COM bases) in nautical miles.
| 268
|- style="background-color:#ddffdd;"
| '''hitBonus'''
| Flat bonus percentage to hit chance.
| 0
|- style="background-color:#ddffdd;"
| '''avoidBonus'''
| Flat bonus percentage to dodge chances against enemy fire (during dogfight).
| 0
|- style="background-color:#ddffdd;"
| '''avoidBonus2'''
| Flat bonus percentage to dodge chances against enemy fire (during xcom base defense).
| 0
|- style="background-color:#ddffdd;"
| '''powerBonus'''
| Multiplier for the weapon power, e.g. 20 = weapon power increased to 120%, -20 = decreased to 80%.
| 0
|- style="background-color:#ddffdd;"
| '''armor'''
| Amount of blocked damage per hit.
| 0
|- style="background-color:#ddffdd;"
| '''shieldCapacity'''
| UFO's maximum shield capacity.
| 0
|- style="background-color:#ddffdd;"
| '''shieldRecharge'''
| Defines the percent chance of recharging a point of shielding per game second (GS) during a Dogfight. Values under 100 are the percent chance, for over 100, every +100 means an automatic +1 to shields per GS. Thus ''shieldRecharge: 250'' means +2 shields/GS, with a 50% chance of +1 more.
| 0
|- style="background-color:#ddffdd;"
| '''shieldRechargeInGeoscape'''
| Similar to '''shieldRecharge''', but acts every 5 seconds in the Geoscape. Giving it a value of -1 means instant recharge as soon as 5 seconds pass!
| 0
|- style="background-color:#ddffdd;"
| '''shieldBleedThrough'''
| Defines the percent of damage that passes the shield when it goes down.  A value of 0 means that with even just 1 shield point, any single hit will be blocked, while 100 means 100% of the damage left after the shield blocks it will go on to damage the UFO.
| 0
|- style="background-color:#ddffdd;"
| '''craftCustomDeploy'''
| Overrides the [[#Deployment Data|deployment data]] used during the Battlescape generation, when the UFO crashes or lands.
| -
|- style="background-color:#ddffdd;"
| '''missionCustomDeploy'''
| Overrides the [[#Deployment Data|deployment data]] used during the Battlescape generation, when the UFO spawns a mission site.
| -
|}

=== Inventory Sections ===

Defines one of the sections of the [[Inventory TU Table|Battlescape inventory]] (eg. Backpack), listed in ''"invs:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| String ID of the inventory name.
| ''required''
|-
| '''x'''
'''y'''
| Pixel coordinates of this section on the inventory screen.
| 0
0
|-
| '''type'''
| Type of this section:
* 0 = Slot section, can contain as many items as will fit on the slots.
* 1 = Hand section, can only contain one item regardless of size.
* 2 = Ground section, can contain infinite items.
| 0
|-
| '''slots'''
| List of the grid slots (''[x, y]'') that this section is composed of. For example, to make a 2x2 section, you would have ''[0, 0] [0, 1] [1, 0] [1, 1]''.
| -
|-
| '''costs'''
| List of [[Time Units]] costs to move an item from this section to another one (eg. ''STR_BACKPACK: 16'' means it will cost 16 TUs to move an item from this section to the Backpack).
| -
|-
|}

=== Terrains ===

Defines one of the [[TERRAIN|terrains]] used to generate a Battlescape map, listed in "terrains:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''name'''
| String ID of the terrain name.
| ''required''
|-
| '''mapDataSets'''
| List of filenames (each with matching [[MCD]]/[[Image Formats#PCK|PCK/TAB]] files) that contain the tiles of this terrain.
| -
|-
| '''mapBlocks'''
| List of map blocks (see below [[#Map Blocks|Map Blocks]]) that are used for generating a map.
| -
|- style="background-color:#ddffdd;"
| '''addOnly'''
| Normally, when loading '''mapBlocks''', any map blocks loaded previously (e.g. from other mods) are deleted first and then new map blocks are added. If this attribute is true, the existing map blocks are not deleted and the new ones are added at the end of the list.
Note: does not apply to '''mapDataSets''' or anything else
| false
|-
| '''civilianTypes'''
| List of units to use as civilians for this mission.
| [MALE_CIVILIAN, FEMALE_CIVILIAN]
|-
| '''music'''
| The list of musics this terrain can choose from (unless overridden by alienDeployment).
| -
|-
| '''depth'''
| Minimum and maximum possible depth, format is [minDepth, maxDepth]. Sets the battlescape depth (randomly, unless overridden by alienDeployment).
| [0, 0]
|-
| '''ambience'''
| The ambient sound effect. Sound ID from [[#Extra_Sounds|BATTLE.CAT]].
| -1
|-
| '''ambientVolume'''
| The volume of the ambient sound effect.
| 0.5
|- style="background-color:#ddffdd;"
| '''ambienceRandom'''
| A list of ambient sound effects (IDs from BATTLE.CAT). Doesn't work when '''ambience''' is defined. Uses '''ambientVolume'''. A random sound effect is chosen each time a sound is played.
| -
|- style="background-color:#ddffdd;"
| '''ambienceRandomDelay'''
| The delay between random ambient sound effects in seconds. Chosen randomly between the defined min and max (after each sound played).

Note: the time passes only when the game is not "busy" (= when you see the map tiles animate). When the tiles don't animate, the timer for ambient sounds doesn't tick.
| [20, 60]
|-
| '''script'''
| The map generation script name.
| DEFAULT
|- style="background-color:#ddffdd;"
| '''mapScripts'''
| List of map scripts used to generate the map (if used, overrides '''script'''). One is chosen at random during map generation.
| -
|- style="background-color:#ddffdd;"
| '''enviroEffects'''
| String ID of enviro effects for missions using this terrain.

Note: if enviro effects are defined both on terrain and on alien deployment, the deployment's enviro effects are used.
| -
|}

==== Map Blocks ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''name'''
| Filename of the [[MAPS|map]].
| ''required''
|-
| '''width'''
| Width of this map block in Battlescape grid units.

Note: in '''MapView''' tool (tested on version 1.6.0.0), this is called ''length''. MapView's dimensions [w, l, h] correspond to OpenXcom's dimensions [l,w,h].
| 10
|-
| '''length'''
| Length of this map block in Battlescape grid units.

Note: in '''MapView''' tool (tested on version 1.6.0.0), this is called ''width''. MapView's dimensions [w, l, h] correspond to OpenXcom's dimensions [l,w,h].
| 10
|-
| '''height'''
| Height of this map block in Battlescape grid units.
| 4
|-
| '''groups'''
| List (or single number) of groups this mapblock belongs to (used in mapscripts)
default usage:
* 0 - Default
* 1 - Landing Zone (for placing X-COM / alien craft) (used in addCraft/addUFO mapscript commands)
* 2 - E-W Road (for city maps) (used in addLine mapscript command)
* 3 - N-S Road (for city maps) (used in addLine mapscript command)
* 4 - Road Crossing (for city maps) (used in addLine mapscript command)

Hint: all maps with an XCOM/Alien craft require at least one map block assigned to Group 1. This map block can only contain ground tiles (no walls or objects).
| 0
|-
|'''revealedFloors'''
| Map block floor to be revealed from the very beginning; use a list "[0, 1, ..]" to reveal multiple floors
| -
|-
| '''items'''
| An array of items to add to this mapblock, and the positions to place them at.
| -
|- style="background-color:#ddffdd;"
| '''fuseTimers'''
| This attribute allows you to pre-prime the items placed on the map using the '''items''' attribute. It's a list of items and information about minimum and maximum fuse timer.

Example:

  items:
    STR_ELERIUM:
      - [0, 0, 0]
    STR_TIMEBOMB:
      - [2, 1, 0]
      - [6, 2, 0]
  fuseTimers:
    STR_TIMEBOMB: [0, 30]

In this example 3 items are placed on the map block: 1 Elerium item and 2 Timebomb items. Both Timebomb items will be pre-primed with a random delay between 0 and 30 (each item will have a different delay). Elerium item will not be pre-primed :)
| -
|- style="background-color:#ddffdd;"
| '''randomizedItems'''
| A list of additional items to add to this mapblock, using a more randomized approach. Since OXCE 8.1, pre-priming of items is also supported.

Example:

  randomizedItems:
    - position: [12, 15, 2]
      amount: 3
      mixed: true
      itemList: [STR_ITEM_1, STR_ITEM_2, STR_ITEM_3, STR_ITEM_3]
      fuseTimerMin: 0  # default is -1 = not used
      fuseTimerMax: 0  # default is -1 = not used

In this example:
* 3 items will be placed on the tile at coordinates [x,y,z] = [12, 15, 2]
* all 3 items can be different (''mixed: true''); if you wanted 3 items of the same type use ''mixed: false''
* items are selected from the ''itemList'' randomly; to increase odds for a certain item type, you can add it to the list multiple times
** in our example STR_ITEM_1 has 25% chance, STR_ITEM_2 also 25% chance and STR_ITEM_3 a 50% chance
| -
|- style="background-color:#ddffdd;"
| '''extendedItems'''
| A list of additional items to add to this mapblock, using a more generic approach. Supports pre-priming of items and spawning weapons with ammo.

Example:

  extendedItems:
    - type: STR_RIFLE
      pos:
        - [6, 2, 0]
      ammoDef: [ [STR_RIFLE_CLIP, 0] ]  # list of loaded ammo with quantity (quantity 0 = maximum), example: [[type1, qty1],[type2, qty2],[type3, qty3],[type4, qty4]]
    - type: STR_GRENADE
      pos:
        - [7, 2, 0]
        - [7, 3, 0]
      fuseTimerMin: 0  # default is -1 = not used
      fuseTimerMax: 0  # default is -1 = not used

| -
|- style="background-color:#ddffdd;"
| '''craftInventoryTile'''
| Coordinates [x, y, z] of the "craft" inventory tile (weapon's pile) in the terrain map block.

More info: https://openxcom.org/forum/index.php?topic=12597.msg171356#msg171356
| -
|}

==== MCD Patches ====

<div style="background:#ffdddd;">
'''DISCLAIMER'''

MCD Patches are '''NOT''' meant for mods and modders!
* they don't offer any advantages over direct MCD manipulation; but suffer several disadvantages

'''Recommendation from OXC and OXCE devs:''' Modders should modify MCD files directly.
</div>

Redefines specific values of MCD files (including tile armor, HEBlock, TUWalk, etc.). The numbers after the #-symbol are representive to the offsets of the [[MCD|MCD files]]

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Filename of the MCD file.
| ''required''
|-
| '''bigWall'''
| Type of BigWall, byte #33. 1 = solid block, 2 = diagonal (--), 3 = diagonal (l), 4 = west wall, 5 = north wall, 6 = east wall, 7 = south wall, 8 = south and east wall, 9 = north and west wall
| -
|-
| '''TUWalk'''
| TU cost to walk on this tile, byte #39. Walking is ground movement by any unit with movementType 0 or 1. If tile is an object or wall, TU cost is added to the TU cost of the floor tile under it.
| -
|-
| '''TUFly'''
| TU cost to fly on this tile, byte #41. Flying is movement not tied to the ground. Some flying units (movementType 1) still walk whenever there is a floor tile underneath them. If tile is an object or wall, TU cost is added to the TU cost of the floor tile under it.
| -
|-
| '''TUSlide'''
| TU cost to slide on this tile, byte #40. Siding is ground movement by any unit with movementType 2. (Example: Snakeman.) If tile is an object or wall, TU cost is added to the TU cost of the floor tile under it.
| -
|-
| '''deathTile'''
| The tile to replace once this tile is destroyed, byte #44. DeathTile must be within the same MCD and cannot use 0 or 1. If You set DeathTile to 0 or 1, they become either air (nothing) (0) or scorched earth (1) from BLANKS.MCD. While a map file cannot initially contain anything beyond its 256 max tile list (0-253 plus BLANKS), OpenXcom is able to render tiles outside of this range during battlescape gameplay. So the final MCD tileset in the terrain's list of tiles may contain some tiles within the 256 limit which are placed initially, and which can then die to become tiles which are outside the limit.
| -
|-
| '''terrainHeight'''
| Height of terrain, byte #48. Used for object tiles. One tile "cube" is 24 voxels in height, and you use negative values to raise the "floor height" of the tile. So a value of -12 would be halfway to the top. Positive values can be used to make its floor sink below the tile.
| -
|-
| '''specialType'''
| Type of tile, used primarily in after-mission item recovery, byte #59. 0 = nothing special; 1 = X-Com entry (used to spawn X-Com units); 2 = UFO Power Source (which has a 75% chance of exploding when the battlescape loads if it is a crash site); 3 = UFO Navigation; 4 = UFO Construction; 5 = Alien Food (UFO), Alien Cryogenics (TFTD); 6 = Alien Reproduction (UFO), Alien Cloning (TFTD); 7 = Alien Entertainment (UFO), Alien Learning Arrays (TFTD); 8 = Alien Surgery (UFO), Genetic Implanter (TFTD); 9 = Examination Room; 10 = Alien Alloys (UFO), Aqua Plastics (TFTD) - by default 10 of these tiles recovers for one unit from a UFO/USO, while 150 tiles recover for one unit from alien base/colony - see recoveryDividers to change this; 11 = Alien Habitat (UFO), Re-animation Zone (TFTD); 12 = damaged UFO tile; 13 = exit point (used to move to next map for the same mission); 14 = alien brain (UFO), T'Leth supports (TFTD) (boss tiles: destroy any of these to win the game). You can define higher numbers for recovery in OpenXcom as long as you put a corresponding specialType of the same value on the ruleset items entry which shall be recovered. But beware, MCDs with specialType greater than 14 may crash your map editor.
| -
|-
| '''explosive'''
| Explosion Strength, byte #55. Changing this value also seems to change the tile's HE_Type:54 value to 0 (high explosive). Most vanilla explosive tiles are type 1 (smoke). There is currently no way to edit the explosive type via mcdPatches.
| -
|-
| '''flammability'''
| Threshold to turn this tile on fire, byte #45. Similar to the tile's armor value, if this value is exceeded with an explosive blast (high explosive type), it will ignite.
| -
|-
| '''fuel'''
| The amount of turns this tile will burn for, byte #57. Seems to be based on fire from tile igniting due to flammability value, and doesn't affect fire caused by an incendiary blast.
| -
|-
| '''footstepSound'''
| Index of the footstep sound, byte #52. 1 = metal, 2 = normal, 3 = furniture? or mountain grass, 4 = water, 5 = sand, 6 = Martian sand (original DOS version), snow (Collector's Edition and most modern editions), 7 = snow (DOS version)
| -
|-
| '''HEBlock'''
| [[Explosions#HE Block|HE Blockage]] Byte #43.
| -
|-
| '''noFloor'''
| Byte #32. 1 = non-flying units will fall through; 0 = units can stand on it.
| -
|-
| '''LOFTS'''
| [[LOFTEMPS.DAT|LOFTEMPS.DAT]] Line Of Fire Template (LOFT) for the tile described as a vector, bytes #8 - #19. Each value corresponds to an index on the LOFT spritesheet and determines the voxel shape of the tile's hitbox. 
| -
|-
| '''stopLOS'''
| Byte #31. 1 = tile blocks vision like a bigwall 1; 0 = tile only blocks vision based on its LOFTs. In some cases setting this to 1 may improve performance.
| -
|-
| '''objectType'''
| Tile type, byte #53. 0 = floor; 1 = west wall; 2 = north wall; 3 = object. Determines how the tile functions when it appears dynamically as a death tile. Does not control how tiles are placed in the map files, however your map editor can reference this and color-code tiles to advise you on its intended placement. May affect tunnels.
| -
|}

<div style="background:#ffdddd;">
'''DISCLAIMER'''

MCD Patches are '''NOT''' meant for mods and modders!
* they don't offer any advantages over direct MCD manipulation; but suffer several disadvantages

'''Recommendation from OXC and OXCE devs:''' Modders should modify MCD files directly.
</div>

Example:

  MCDPatches:
    - type: BARN: # /UFO/TERRAIN/BARN.MCD
      data:
      - MCDIndex: 0 # index 0 of BARN.MCD
        armor: 255 # make tile nearly indestructible 
        HEBlock: 200 # may block blaster bombs

=== Map Scripts ===
Defines how the battlescape maps are generated from the available map blocks, listed in "mapScripts:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| name of the script
| ''required''
|-
| '''commands'''
| List of MapCommands
| -
|}

==== Map Command ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Currently these commands are implemented:
* addBlock - adds a mapblock can be combined with size, group, executions and blocks (for a weighted list)
* addLine - adds a line of mapblocks from groups (roads for example)
* addCraft - adds X-Com craft towards map
* addUFO - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions. 
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''required''
|-
| '''rects'''
| A list of possible areas on the map where (random) placement/checks/removal can happen. If not specified, entire map is considered.
Each item in the list is a group of four integers [x, y, width, length].
| -
|-
| '''label'''
| A numeric label that can be used for conditional execution of commands. Please make sure that you use positive and unique labels (unique within the command). If you try using negative labels, OpenXcom will convert them to positive (abs. value) anyway. If you try using non-unique labels, you'll get undefined behavior.
| 0
|-
| '''conditionals'''
| Defines the pre-conditions for the execution of this command. For example [1, -4] means it will be executed if command with '''label''' 1 was a success and command with '''label''' 4 failed.
Note: commands that are not yet executed are always in failed state.
| 0
|-
| '''size'''
| Size of map blocks that can be placed/checked/removed within '''rects'''. Only width (sizeX) and length (sizeY) are relevant. Can be specified as a single value, which is then used as both width and length; or as group of up to three values [x, y, z].

Also used for resize command type, which can use also the height value (sizeZ).
| [1, 1, 0]
|- style="background-color:#ddffdd;"
| '''markAsReinforcementsBlock'''
| Marks blocks placed during this command as relevant for in-battle alien/civilian '''reinforcements'''.
| false
|-
| '''groups'''
| Defines what types of map blocks can be used within this command. Can be defined as a list or as a single value.
| 0
|- style="background-color:#ddffdd;"
| '''craftGroups'''
| This command will only be executed if a craft with a corresponding craft group was deployed already.
| -
|- style="background-color:#ddffdd;"
| '''horizontalGroup'''
| Allows to override group used in addLine command.
| 2
|- style="background-color:#ddffdd;"
| '''verticalGroup'''
| Allows to override group used in addLine command.
| 3
|- style="background-color:#ddffdd;"
| '''crossingGroup'''
| Allows to override group used in addLine command.
| 4
|-
| '''blocks'''
| Alternative to '''groups'''. Here we define an explicit list of map blocks that can be used within this command.

Important: The list is defined by map block sequential IDs (not by name!), where first map block has sequential ID = 0 (not 1).
| 0
|-
| '''freqs'''
| Defines the distribution frequency for the '''groups''' or '''blocks''' (see above). If not used, all groups/blocks have frequency 1.
| 1
|-
| '''maxUses'''
| Defines the maximum number of uses for the '''groups''' or '''blocks''' (see above). If not used, all groups/blocks have frequency -1 (=unlimited).
| -1
|-
| '''tunnelData'''
| Parameter for digTunnel command type. Contains a '''level''' (default: 0) and a list of MCD replacement rules ('''MCDReplacements''')
| -
|-
| '''direction'''
| Parameter for digTunnel and addLine command types. Values are: both, horizontal or vertical.
| -
|-
| '''executionChances'''
| The probability (0-100%) that this command will be executed (or fails).
| 100
|-
| '''executions'''
| This command will be executed multiple times with a value > 1.
| 1
|-
| '''UFOName'''
| String ID of the UFO to be placed.
| -
|- style="background-color:#ddffdd;"
| '''canBeSkipped'''
| Only relevant for ''addUFO'' command with no '''label''' defined. Determines, whether an unsuccessful ''addUFO'' command can be skipped (and logged into the log file) or whether the game should crash.

Note: this attribute is more or less deprecated. Maybe useful for testing/debugging?
| true
|- style="background-color:#ddffdd;"
| '''craftName'''
| String ID of the craft to be placed.

Note: this can be used to replace the craft you arrived with (e.g. Skyranger) with a new vehicle you used to make the last section of your journey. For example a small submarine for an underwater mission or an APC for a mission, where you couldn't land or didn't want to make too much noise :)
| -
|- style="background-color:#ddffdd;"
| '''terrain'''
| String ID of an alternate terrain to be used for this command only. Used for example when you want to sneak in a few blocks from FOREST terrain into a map made predominantly using FARM terrain.

There is a special constant '''globeTerrain''', which takes a random terrain corresponding to the globe texture, where the mission takes place. More info here: https://openxcom.org/forum/index.php/topic,7536.0.html

There is also a special constant '''baseTerrain''' for base defense missions, which takes the terrain from the globe definition (see also '''baseDefenseMapFromLocation'''). More info: https://openxcom.org/forum/index.php/topic,5108.0.html
| -
|- style="background-color:#ddffdd;"
| '''randomTerrain'''
| Alternative to '''terrain'''. A list of string IDs, one of them is chosen randomly.

More info: https://openxcom.org/forum/index.php/topic,7758.0.html
| -
|- style="background-color:#ddffdd;"
| '''verticalLevels'''
| Allows using a set of map blocks (of various vertical sizes) stacked on top of each other... instead of just a single map block.

More info: https://openxcom.org/forum/index.php/topic,5316.0.html
| -
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD: 
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]]; 
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense); 
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly. 
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map. 
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Armor ===

Defines a Battlescape unit's [[armor]] as well as visual representation (so every unit has an armor), listed in ''"armors:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="100" | Default
|-
| '''type'''
| String ID of the armor name.
| ''required''
|- style="background-color:#ddffdd;"
| '''ufopediaType'''
| String ID of alternate ufopedia article for this armor (when accessed via middle-button click).

More info: https://openxcom.org/forum/index.php/topic,8707.msg133338.html#msg133338
| -
|- style="background-color:#ddffdd;"
| '''group'''
| Armor group (integer number) used in '''allowedArmorGroups''' in craft ruleset.

More info: https://openxcom.org/forum/index.php?topic=12626.msg171747#msg171747
| 0
|- style="background-color:#ddffdd;"
| '''requires'''
| The research required to equip this armor.

Modding hint: it is possible to equip one "store item" as several different armors, e.g. as armor with or without a helmet. This option allows you to limit some of those options by a research topic. You could use this also for example to define different armor variants for each game difficulty level, e.g. make armor stronger for beginners and weaker for veterans.
| -
|- style="background-color:#ddffdd;"
| '''requiresAward'''
| A commendation required to equip this armor.
| -
|- style="background-color:#ddffdd;"
| '''requiresBonus'''
| A soldier bonus required to equip this armor.
| -
|- style="background-color:#ddffdd;"
| '''ranks'''
| Soldier rank(s) required to equip this armor.

More info: https://openxcom.org/forum/index.php?topic=12731.0
| -
|-
| '''spriteSheet'''
| Sprite sheet from [[UNITS]] used to draw a unit wearing this armor.
| -
|-
| '''spriteInv'''
| Sprite used for the [[Inventory Backgrounds]] of a unit wearing this armor.
| -
|- style="background-color:#ddffdd;"
| '''layersDefaultPrefix''' '''layersSpecificPrefix''' '''layersDefinition'''
| Alternative way of defining/creating inventory sprites (a.k.a. paperdolls), in layers.

More info: https://openxcom.org/forum/index.php/topic,6290.msg104464.html#msg104464
| -<br/>-<br/>-
|-
| '''allowInv'''
| Can the inventory of this armor be accessed or not?
| true
|- style="color:#666666;"
| '''corpseItem'''
| ''Deprecated:'' use '''corpseGeo''' and '''corpseBattle''' instead.
| -
|-
| '''corpseBattle'''
| List of string IDs of the corpse [[#Items|items]] generated when a unit wearing this armor is killed/stunned (1 for 1x1 unit, 4 for 2x2 unit) on the Battlescape.
| -
|-
| '''corpseGeo'''
| String ID of the corpse [[#Items|item]] recovered in Debriefing. Defaults to '''corpseBattle''' if omitted.

Tip for modders: useful for example when you want to recover a "damaged" version of a soldier's armor.
| -
|- style="background-color:#ddffdd;"
| '''selfDestructItem'''
| String ID of an [[#Items|item]] used for self destruct. Defaults to '''corpseGeo''' if omitted.

Tip for modders: self destruct can now also spawn items or units.
| -
|-
| '''storeItem'''
| String ID of the [[#Items|item]] that represents this armor in [[Base Stores]] for equipping. Set to ''STR_NONE'' to not require an item (eg. [[coveralls]]).
| -
|- style="background-color:#ddffdd;"
| '''specab'''
| Special ability of an xcom soldier wearing this armor:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]] (Requires '''power''' and '''blastRadius''' properties to be set on the corpse)
* 2 = [[Silacoid|Burns Floor]]
* 3 = [[Bio-Drone|Burns Floor and explodes on Death]]

Note: Explodes on Death refers to when the unit is collapsing. This can be either be due to the unit not having any remaining HPs or that the stun level exceeds its HP. Only when the damageType is set to DT_STUN, DT_HE, DT_IN or DT_MELEE (OpenXcom) or the value for damageAlter '''IgnoreSelfDestruct''' on the damaging item is set to true (OpenXcom Extended), the unit will '''not''' explode.
| 0
|-
| '''specialWeapon'''
| Alternative method of defining a melee/psi weapon for aliens (and civilians); instead of defining it on the unit itself.

<span style="background:#ddffdd;">Note: in OXCE, this can be used also for Soldiers. It can be any type of weapon (not only melee/psi) and does not block the inventory. Instead it is accessed via a special icon.</span>
| -
|- style="background-color:#ddffdd;"
| '''builtInWeapons'''
| Alternative method of defining built-in weapons for aliens (and civilians); instead of defining them on the unit itself. Can be used also for Soldiers.
| -
|-
| '''frontArmor'''
| Protection provided on the front of the unit.
| 0
|-
| '''sideArmor'''
| Protection provided on the sides of the unit.
| 0
|- style="background-color:#ddffdd;"
| '''leftArmorDiff'''
| Used to define different armor values on the sides (left/right). If specified, left side armor = '''sideArmor''' + '''leftArmorDiff'''.
| 0
|-
| '''rearArmor'''
| Protection provided on the rear of the unit.
| 0
|-
| '''underArmor'''
| Protection provided under the unit (e.g. from explosions).
| 0
|-
| '''drawingRoutine'''
| Drawing routine used to put together the body parts in the unit's '''spriteSheet''':
* 0 = [[Soldier]], [[Sectoid]]
* 1 = [[Floater]]
* 2 = [[HWP]]
* 3 = [[Cyberdisk]]
* 4 = [[Civilian]], [[Ethereal]]
* 5 = [[Sectopod]], [[Reaper]]
* 6 = [[Snakeman]]
* 7 = [[Chryssalid]]
* 8 = [[Silacoid]]
* 9 = [[Celatid]]
* 10 = [[Muton]] (identical to routine 0 except for the placement of a single arm frame while walking in a specific direction, use routine 0 instead)
* 11 = [[Submersible Weapons Systems]]
* 12 = [[Hallucinoid]]
* 13 = [[Aquanauts]]
* 14 = [[Calcinite]], [[Deep One]], [[Gillman]], [[Lobster Man]], [[Tasoth]]
* 15 = [[Aquatoid]]
* 16 = [[Bio-Drone]]
* 17 = TFTD Civilians type A and [[Zombie_(TFTD)]]
* 18 = TFTD Civilians type B
* 19 = [[Tentaculat]]
* 20 = [[Triscene]]
* 21 = [[Xarquid]]
* 22 = Inverted [[Cyberdisc]] (propulsion animation on top)
| 0
|-
| '''drawBubbles'''
| Set to true for units that breathe underwater, e.g. humans and humanoid aliens.

Note: in vanilla this is set to true for all units using '''drawingRoutine''' 13 and 14.
| false
|-
| '''movementType'''
| Type of movement provided by this armor:
* 0 = Walking
* 1 = Flying
* 2 = Sliding (no walking animation)
* 3 = Floating (fly underwater, walk on the surface)
* 4 = Sinking (walk underwater, fly on the surface)
it also defines the body of a tank (32-images) in your spriteSheet or the change in sprites while flying using a flying armor see: [[TANKS.PCK]], [[XCOM_2.PCK]]
| 0
|- style="background-color:#ddffdd;"
| '''moveCost'''
| Detailed configs for custom move costs. Defaults:
    moveCost:
      #first level of multipliers
      basePercent: [100, 100] #overall move cost
    
      #second level of multipliers
      baseNormalPercent: [100, 100] #move cost for ground
      baseFlyPercent: [100, 100] #move cost for flying
      baseClimbPercent: [100, 100] #move cost for climbing ladders
    
      #third level of multipliers
      walkPercent: [100, 50] #cost of normal move type
      runPercent: [75, 75] #cost of run aka with `ctrl`
      strafePercent: [100, 50] #cost of strafe when `ctrl` and only one tile aside
      sneakPercent: [100, 50] #cost move type with `alt`, force unit to move on ground
    
      flyWalkPercent: [100, 50] #cost of normal move type in air
      flyRunPercent: [75, 75] #cost of run aka with `ctrl` in air
      flyStrafePercent: [100, 50] #cost of strafe when `ctrl` and only one tile aside in air
      flyUpPercent: [100, 0] #cost of flying up
      flyDownPercent: [100, 0] #cost of flying down
      climbUpPercent: [100, 50] #cost of climbing up
      climbDownPercent: [100, 50] #cost of climbing down
      gravLiftPercent: [100, 0] #cost for using gravLift
|
|- style="background-color:#ddffdd;"
| '''turnBeforeFirstStep'''
| If enabled, the cost of turning at the beginning of the walking sequence will always be considered.

Note: if disabled, the turn cost will be considered only if the walking sequence is interrupted before the first step, e.g. when a new enemy spotted while turning.
| false
|- style="background-color:#ddffdd;"
| '''turnCost'''
| How many TUs does it cost to make a 45 degree turn.

Note: doesn't apply to turning a tank turret (that is still hardcoded to 1 TU).
| 1
|- style="background-color:#ddffdd;"
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a unit wearing this armor moves (overrides unit's moveSound).
| -1
|- style="background-color:#ddffdd;"
| '''deathMale/deathFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a unit wearing this armor dies. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''selectUnitMale/selectUnitFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a unit wearing this armor is manually selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''startMovingMale/startMovingFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a unit wearing this armor starts moving. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''selectWeaponMale/selectWeaponFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a weapon of a unit wearing this armor is selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''annoyedMale/annoyedFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when a unit wearing this armor is repeatedly manually selected. A list of sound IDs can be used too.
| - 
|-
| '''size'''
| Size of the unit wearing this armor, in Battlescape grid units. 1 means 1x1 unit, 2 means 2x2 unit, other sizes are not supported.
| 1
|-
| '''weight'''
| Physical weight of the armor when worn.
| 0
|- style="background-color:#ddffdd;"
| '''visibilityAtDark'''
| How far can the unit wearing this armor see during darkness. Default 0 uses 9 for X-Com, but for Aliens it uses the maxViewDistance variable (default 20).
| 0
|- style="background-color:#ddffdd;"
| '''visibilityAtDay'''
| How far can the unit wearing this armor see during the day. Default 0 uses the maxViewDistance variable (default 20). Both of these variables only affect how far away units may be seen. Terrain revealed is always based on maxViewDistance, day or night.
| 0
|- style="background-color:#ddffdd;"
| '''personalLight'''
| Intensity of personal light for a friendly unit wearing this armor.
| 15
|- style="background-color:#ddffdd;"
| '''personalLightHostile'''
| Intensity of personal light for a hostile unit wearing this armor.
| 0
|- style="background-color:#ddffdd;"
| '''personalLightNeutral'''
| Intensity of personal light for a neutral unit wearing this armor.
| 0
|- style="background-color:#ddffdd;"
| '''camouflageAtDay'''
| Makes the unit wearing this armor less visible during the day. Positive numbers set absolute distance (e.g. 7 means that unit is visible from 7 tiles away), negative numbers set relative distance (e.g. -10 means that unit is visible from a distance that is 10 tiles shorter than usual). Cannot decrease visibility below 1 tile.
| 0
|- style="background-color:#ddffdd;"
| '''camouflageAtDark'''
| Makes the unit wearing this armor less visible during darkness. Positive or negative, same as above.
| 0
|- style="background-color:#ddffdd;"
| '''antiCamouflageAtDay'''
| Cancels enemy camouflage by a specified amount (of tiles) during the day. Cannot increase visibility beyond the usual (e.g. camo = -5 and antiCamo = 7 still only evens out, it doesn't provide 2 additional tiles of visibility).
| 0
|- style="background-color:#ddffdd;"
| '''antiCamouflageAtDark'''
| Cancels enemy camouflage by a specified amount (of tiles) during darkness. Cannot increase visibility beyond the usual.
| 0
|- style="background-color:#ddffdd;"
| '''heatVision'''
| Allows seeing better through smoke. Percentage (0-100%) value defining how much smoke is ignored.
| 0
|- style="background-color:#ddffdd;"
| '''visibilityThroughFire'''
| Allows seeing worse through fire. Percentage (0-100%) value defining how much fire is ignored.
| 100
|- style="background-color:#ddffdd;"
| '''psiVision'''
| Allow "seeing" through walls. Units with this armor can sense enemies that are 'psiVision' tiles (or less) away.

Note: cannot sense enemies that are '''fearImmune'''.
| 0
|- style="background-color:#ddffdd;"
| '''psiCamouflage'''
| Allows defense against '''psiVision'''.

More info: https://openxcom.org/forum/index.php/topic,7816.msg132821.html#msg132821
| 0
|- style="background-color:#ddffdd;"
| '''alwaysVisible'''
| When set to '''true''', the unit will always be visible to the player.
| false
|-
| '''stats'''
| Like soldier stats (see below) but these are treated as stat bonuses while wearing a given type of armor.
| -
|-
| '''damageModifier'''
| List of decimal damage modifiers (1.0 = 100%) this armor applies to each damage type (see [[#Items|Items section]]) received. Modifiers must be specified for all damage types, in this order:
* None 
* Armor Piercing 
* Incendiary 
* High Explosive 
* Laser 
* Plasma 
* Stun 
* Melee 
* Acid 
* Smoke
<div style="background:#ddffdd;">In OXCE, there are 10 additional (nameless) damage types, which you can name and use for any purpose you like (e.g. create Electric damage, Freeze damage, EMP damage or whatever). You are also not forced to specify all 20 values if you are using less. If you for example only use 2 additional damage types, it is enough to specify only 12 (10 vanilla + 2 additional).
</div>
| 
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0<br>
- 1.0
|-
| '''loftempsSet'''
| List of [[LOFTEMPS]] IDs (1 for 1x1 units, 4 for 2x2 units) used to represent a unit wearing this armor in 3D voxel space.

Notes: Because of bug in unit voxel logic for 2x2 units only '''[ 92, 89, 90, 91 ]''' is correctly handled
| -
|- style="color:#666666;"
| '''loftemps'''
| ''Deprecated:'' use '''loftempsSet''' instead.
| -
|-
| '''deathFrames'''
| Number of "death frames" = sprites in the death animation sequence.
| 3
|- style="background-color:#ddffdd;"
| '''overKill'''
| Defines how much damage (over the maximum HP) is needed to vaporize/disintegrate a unit upon hit. Defined as percentage, e.g. 0.6 = 60% of maximum HP.

Notes:
* If a unit is disintegrated, it will have a different death animation and it will not leave any corpse.
* Weapons can be configured to cause disintegration or not (e.g. explosives vs bullets), see '''IgnoreOverKill''' (by default all weapons ignore overkill).
| 0.5
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''forcedTorso'''
| Soldier sprites have female and male torsos. Some armors reuse these sprites for flying/non flying torso without difference between genders. This can be controlled by the parameter:
* 0 = use gender-specific torso
* 1 = use male torso
* 2 = use female torso 
| 0
|-
| '''spriteFaceGroup'''
| [[PALETTES.DAT#Color Indexes|Palette]] offset (1-15) used for replacing colors when drawing units. Replacement is based on unit's avatar (gender & look). Default 0 (unused).
As the name suggests, it is usually used to recolor faces.
| ''example:'' <br> 6
|-
| '''spriteHairGroup'''
| [[PALETTES.DAT#Color Indexes|Palette]] offset (1-15) used for replacing colors when drawing units. Replacement is based on unit's avatar (gender & look). Default 0 (unused).
As the name suggests, it is usually used to recolor hair.
| ''example:'' <br> 9
|-
| '''spriteUtileGroup'''
| [[PALETTES.DAT#Color Indexes|Palette]] offset (1-15) used for replacing colors when drawing units. Replacement is based on unit's avatar (gender & look). Default 0 (unused).
Doesn't have any suggested use, feel free to use it to recolor anything you want :)
| 0
|-
| '''spriteRankGroup'''
| [[PALETTES.DAT#Color Indexes|Palette]] offset (1-15) used for replacing colors when drawing units. Replacement is based on unit's "rank" (see below for details). Default 0 (unused).
Doesn't have any suggested use, feel free to use it to recolor anything you want... for example Floater robes :)
| 0
|-
| '''spriteFaceColor'''
| New color index (0-255) for "face pixels". List of 8 values corresponding to the following avatars:
* Male Blond, Female Blond, Male Brown, Female Brown, Male Asian, Female Asian, Male African, Female African
Aliens and civilians use random value from this list. Value 0 means "no change".
Example: [96, 96, 96, 96, 160, 160, 163, 163]
| -
|-
| '''spriteHairColor'''
| New color index (0-255) for "hair pixels". List of 8 values corresponding to the same avatars as above.
Aliens and civilians use random value from this list. Value 0 means "no change".
Example: [144, 144, 164, 164, 245, 245, 166, 166]
| -
|-
| '''spriteUtileColor'''
| New color index (0-255) for "util pixels". List of 8 values corresponding to the same avatars as above.
Aliens and civilians use a random value from this list. Value 0 means "no change".
| -
|-
| '''spriteRankColor'''
| New color index (0-255) for "rank pixels".
For soldiers, a list of 6 values corresponding to the following xcom ranks:
* STR_ROOKIE, STR_SQUADDIE, STR_SERGEANT, STR_CAPTAIN, STR_COLONEL, STR_COMMANDER
For aliens, a list of 7 values corresponding to the following alien ranks:
* STR_LIVE_SOLDIER, STR_LIVE_ENGINEER, STR_LIVE_MEDIC, STR_LIVE_NAVIGATOR, STR_LIVE_LEADER, STR_LIVE_COMMANDER, STR_LIVE_TERRORIST
For civilians, a list of 8 values... one will be chosen randomly (since civilians don't have ranks).
Value 0 means "no change".
| -
|-
| '''units'''
| List of soldier types this armor applies to. Empty = applies to all soldier types.
| -
|- style="background-color:#ddffdd;"
| '''customArmorPreviewIndex'''
| Allows to have different icons for different types of armor on the [Craft Info] screen. Defined either as a single index into the '''CustomArmorPreviews''' spritesheet, or as a list of indices (for bigger icons).
| 0
|- style="background-color:#ddffdd;"
| '''allowsRunning'''
| Does this armor allow running? Defaults are: true = for 1x1 units, false = for 2x2 units.
| vanilla
|- style="background-color:#ddffdd;"
| '''allowsStrafing'''
| Does this armor allow strafing? Defaults are: true = for 1x1 units, false = for 2x2 units.
| vanilla
|- style="background-color:#ddffdd;"
| '''allowsSneaking'''
| Does this armor allow sneaking? (with '''alt''', forces a unit to move on the ground even if it can fly) Defaults are: true = for 1x1 units, false = for 2x2 units.
| <=
|- style="background-color:#ddffdd;"
| '''allowsKneeling'''
| Does this armor allow kneeling? Defaults are: true = for xcom soldiers, false = for xcom vehicles, aliens and civilians.
| vanilla
|- style="background-color:#ddffdd;"
| '''allowsMoving'''
| Does this armor allow moving?
| true
|- style="background-color:#ddffdd;"
| '''isPilotArmor'''
| Can this armor provide stat bonuses for pilots during dogfights?
| false
|- style="background-color:#ddffdd;"
| '''allowTwoMainWeapons'''
| During autoequip (e.g. when equipping built-in armor weapons), allow 2 main weapons. Only applies to XCOM, aliens and civilians have it allowed by default.
| false
|- style="background-color:#ddffdd;"
| '''instantWoundRecovery'''
| Should the health of a unit with this armor be automatically set back to maximum after the battle is over?

Note: used for example for vehicles implemented as soldier types (so that they can gain experience too).
| false
|- style="background-color:#ddffdd;"
| '''standHeight'''
| Overrides the unit's/soldier's normal standHeight when wearing this armor.
| -1
|- style="background-color:#ddffdd;"
| '''kneelHeight'''
| Overrides the unit's/soldier's normal kneelHeight when wearing this armor.
| -1
|- style="background-color:#ddffdd;"
| '''floatHeight'''
| Overrides the unit's/soldier's normal floatHeight when wearing this armor.
| -1
|- style="background-color:#ddffdd;"
| '''meleeOriginVoxelVerticalOffset'''
| Overrides the unit's offset for melee attacks. See https://openxcom.org/forum/index.php?topic=12068.0
| 0
|- style="background-color:#ddffdd;"
| '''fearImmune'''
| Is this unit immune to morale loss (and '''psiVision''')? Defaults are: false = for 1x1 units, true = for 2x2 units.
| vanilla
|- style="background-color:#ddffdd;"
| '''bleedImmune'''
| Is this unit immune to bleeding? Defaults are: false = for 1x1 xcom soldiers, true = for everything else.

Note: game option ''alienBleeding'' affects the defaults too.
| vanilla
|- style="background-color:#ddffdd;"
| '''painImmune'''
| Is this unit immune to stun damage? Defaults are: false = for 1x1 units, true = for 2x2 units.

Note: weapons can be modded to ignore this immunity (by default all weapons with damageType=6 (stun) will ignore it).
| vanilla
|- style="background-color:#ddffdd;"
| '''zombiImmune'''
| Is this unit immune to "zombification"? Defaults are: false = for 1x1 units, true = for 2x2 units.

Note: this setting works for 1x1 units only; save your time and don't try changing it for 2x2 units.
| vanilla
|- style="background-color:#ddffdd;"
| '''ignoresMeleeThreat'''
| Is this unit immune to CQC? Defaults are: false = for 1x1 units, true = for 2x2 units.
| <=
|- style="background-color:#ddffdd;"
| '''createsMeleeThreat'''
| Is this unit capable of CQC? Defaults are: false = for 2x2 units, true = for 1x1 units.
| <=
|- style="background-color:#ddffdd;"
| '''meleeDodgeBackPenalty'''
| Defines the penalty to unit's melee dodge ability (see '''meleeDodge''') when attacked from behind. Defined as percentage, e.g. 0.7 = 70%.

Note: The full penalty applies from behind, from sides the penalty is adjusted accordingly. There is no penalty for frontal assault.
| 0.0
|- style="background-color:#ddffdd;"
| '''ai.targetWeightAsHostile'''<br/>'''ai.targetWeightAsHostileCivilians'''<br/>'''ai.targetWeightAsFriendly'''<br/>'''ai.targetWeightAsNeutral'''
| More info: https://openxcom.org/forum/index.php?topic=6586.msg171202#msg171202

  ai:
    targetWeightAsHostile: ~ # use global value
    targetWeightAsHostileCivilians: 50
    targetWeightAsFriendly: ~ # use global value
    targetWeightAsNeutral: -100

| ~<br/>~<br/>~<br/>~
|}

The following group of attributes has rather complicated definition (listed in a separate table just for convenience).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="100" | Default
|- style="background-color:#ddffdd;"
| '''psiDefence'''
| Formulae for psi defense value.
| vanilla
|- style="background-color:#ddffdd;"
| '''meleeDodge'''
| Formulae for melee dodge chance.
| 0
|- style="background-color:#ddffdd;"
| '''recovery.time'''
| Formulae for TU recovery at the beginning of a new turn.

Note: this and all attributes below are defined under parent attribute '''recovery''' and a child attribute (time, energy, morale, etc.)
| vanilla
|- style="background-color:#ddffdd;"
| '''recovery.energy'''
| Formulae for Energy recovery at the beginning of a new turn.
| vanilla
|- style="background-color:#ddffdd;"
| '''recovery.morale'''
| Formulae for Morale recovery at the beginning of a new turn.
| 0
|- style="background-color:#ddffdd;"
| '''recovery.health'''
| Formulae for HP recovery at the beginning of a new turn.
| 0
|- style="background-color:#ddffdd;"
| '''recovery.stun'''
| Formulae for Stun Level recovery at the beginning of a new turn.
| vanilla
|- style="background-color:#ddffdd;"
| '''recovery.mana'''
| Formulae for mana recovery at the beginning of a new turn.
| 0
|}

<div style="background:#ddffdd;">Easiest way to explain how the formulaes are defined is using examples:

  armors:
    - type: STR_TEST_ARMOR_1
      meleeDodge:
        reactions: 0.2               # 20% of reactions
    - type: STR_TEST_ARMOR_2
      recovery:
        health:
          stunNormalized: -0.1       # -10% of normalized stun
        energy:
          flatHundred: 0.1           # 10% of 100 = 10 :)
          healthCurrent: 0.25        # 25% of current health

Armor 1 has melee dodge equal to 20% of soldier's reactions stat.

Armor 2 has negative HP recovery of 10% of soldier's normalized stun level (simulating slowly losing HP when in shock); and positive energy recovery of 10 + 25% of soldier's current health.

There are even more complicated examples with squared and cubed stats, see [[#Items|Items]] ruleset for some examples of that.

Possible keywords to use in the formulaes include:
* flatOne, flatHundred
* tu, stamina, health, bravery, reactions, firing, throwing, strength, psiStrength, psiSkill, melee, mana
* psi, strengthMelee, strengthThrowing, firingReactions
* tuScaled, staminaScaled, healthScaled, braveryScaled, reactionsScaled, firingScaled, throwingScaled, strengthScaled, psiStrengthScaled, psiSkillScaled, meleeScaled, manaScaled
* psiScaled, strengthMeleeScaled, strengthThrowingScaled, firingReactionsScaled
* rank, rankUnified, fatalWounds
* tuCurrent, energyCurrent, healthCurrent, stunCurrent, moraleCurrent, manaCurrent
* tuNormalized, energyNormalized, healthNormalized, stunNormalized, moraleNormalized, manaNormalized
* energyRegen

'''FIXME''': describe what each keyword means
</div>

=== Player Units (Soldiers) ===

Defines a [[soldier]] recruited by X-COM, listed in ''"soldiers:"''.

Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]]
* [https://openxcom.org/forum/index.php/topic,7241.0.html mana] - OXCE only

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|- style="background-color:#ddffdd;"
| '''group'''
| Allows grouping of soldier types. Used in craft restrictions.

More info: https://openxcom.org/forum/index.php?topic=10678.msg161784#msg161784
| 0
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyBaseFunc'''
| A list of services (for a given base) required to be able to hire this soldier type.
| -
|- style="background-color:#ddffdd;"
| '''requiresBuyCountry'''
| An allied country required to be able to hire this soldier.
| -
|-
| '''minStats'''
| Minimum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the initial stat (not generated).
| -
|-
| '''maxStats'''
| Maximum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the minimum value for the first month of psi training (actual value is 100%-150%).
| -
|-
| '''statCaps'''
| Maximum stats this soldier can gain through [[Experience]]. '''NOTE:''' A stat will still go over the limit once, and then will no longer increase (see [[Experience#Regarding Caps|Regarding Caps]]).
| -
|- style="background-color:#ddffdd;"
| '''trainingStatCaps'''
| Maximum stats this soldier can gain through combat/martial training in the base.
Note: since OXCE v7.2, it can also be used to disable psi-training: https://openxcom.org/forum/index.php/topic,10208.msg142696.html#msg142696
| '''statCaps'''
|- style="background-color:#ddffdd;"
| '''dogfightExperience'''
| A list of probabilities (0-100%) to improve a stat (only bravery, firing or reactions) after a successful Dogfight.

  - type: STR_SOLDIER
    dogfightExperience:
      bravery: 20   # 20% chance of improvement by 10
      reactions: 50 # 50% chance to improve by 1
      firing: 100   # guaranteed to improve by 1

| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this soldier uses by default.
| -
|- style="background-color:#ddffdd;"
| '''armorForAvatar'''
| When avatar display is activated in the Battlescape UI (instead of rank display)... which armor should the unit be wearing?

Note: things like Power/Flying Armor don't show the soldier's face, so you'd want to use Jumpsuits or Personal Armor.
| -
|- style="background-color:#ddffdd;"
| '''avatarOffsetX'''
| Horizontal offset (in pixels) in the inventory sprite used for avatar display.
| 67
|- style="background-color:#ddffdd;"
| '''avatarOffsetY'''
| Vertical offset (in pixels) in the inventory sprite used for avatar display.
| 48
|- style="background-color:#ddffdd;"
| '''flagOffset'''
| Offset in the flag sprite collection to use for this soldier type.

Note: OXCE supports flag display per "nationality" (or better said per name pool file).
| 0
|- style="background-color:#ddffdd;"
| '''allowPromotion'''
| Does this soldier type support promotion? Hint: combat dogs don't need a military hierarchy :)
| true
|- style="background-color:#ddffdd;"
| '''allowPiloting'''
| Is this soldier type capable of piloting a craft? Sorry, no doggies piloting a Skyranger.
| true
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen. 
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimit'''
| How many soldiers of this type you can hire per month. 0 = infinite.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyBuyLimitMessage'''
| Custom message for '''monthlyBuyLimit'''. More info: https://openxcom.org/forum/index.php?topic=12812.0
| -
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|- style="background-color:#ddffdd;"
| '''costSalarySquaddie'''
| Bonus to a salary for a Squaddie.
| 0
|- style="background-color:#ddffdd;"
| '''costSalarySergeant'''
| Bonus to a salary for a Sergeant.
| 0
|- style="background-color:#ddffdd;"
| '''costSalaryCaptain'''
| Bonus to a salary for a Captain.
| 0
|- style="background-color:#ddffdd;"
| '''costSalaryColonel'''
| Bonus to a salary for a Colonel.
| 0
|- style="background-color:#ddffdd;"
| '''costSalaryCommander'''
| Bonus to a salary for a Commander.
| 0
|-
| '''standHeight'''
| Height of this soldier when standing.
| 0
|-
| '''kneelHeight'''
| Height of this soldier when kneeling.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''femaleFrequency'''
| The probability that a female soldier is hired.
| 50
|-
| '''value'''
| The soldier's base value, without experience modifiers. Used for scoring in Debriefing.
| 20
|-
| '''transferTime'''
| The amount of time (in hours) it takes for new recruits of this soldier type to arrive at a base. If 0, global personnel transfer time is used instead.
| 0
|- style="background-color:#ddffdd;"
| '''moraleLossWhenKilled'''
| Percentage modifier for morale loss when this unit is killed.

Hint: set 0% for xcom security cameras and 500% for doggies.
| 100
|-
| '''deathMale'''
| Death sound(s) for male soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|-
| '''deathFemale'''
| Death sound(s) for female soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|- style="background-color:#ddffdd;"
| '''selectUnitMale/selectUnitFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this soldier is manually selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''startMovingMale/startMovingFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this soldier starts moving. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''selectWeaponMale/selectWeaponFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this soldier's weapon is selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''annoyedMale/annoyedFemale'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this soldier is repeatedly manually selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''panicMale'''
| Panic sound(s) for male soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|- style="background-color:#ddffdd;"
| '''panicFemale'''
| Panic sound(s) for female soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|- style="background-color:#ddffdd;"
| '''berserkMale'''
| Berserk sound(s) for male soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|- style="background-color:#ddffdd;"
| '''berserkFemale'''
| Berserk sound(s) for female soldiers. Either a single sound ID or a list of sound IDs from [[#Extra_Sounds|BATTLE.CAT]].
| -
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|- style="background-color:#ddffdd;"
| '''statStrings'''
| Override of global stat strings for this soldier type.
| -
|- style="background-color:#ddffdd;"
| '''rankStrings'''
| Override for classic xcom ranks. You can have for example only Rookies and Veterans for a certain soldier type.
| -
|- style="background-color:#ddffdd;"
| '''rankSprite'''
| Offset for rank sprites for this soldier type in BASEBITS.PCK
| 42
|- style="background-color:#ddffdd;"
| '''rankBattleSprite'''
| Offset for rank sprites for this soldier type in SMOKE.PCK
| 20
|- style="background-color:#ddffdd;"
| '''rankTinySprite'''
| Offset for rank sprites for this soldier type in TinyRanks
| 0
|- style="background-color:#ddffdd;"
| '''skillIconSprite'''
| Sprite ID from SPICONS.DAT used to draw the soldier skills icon.
| 1
|- style="background-color:#ddffdd;"
| '''skills'''
| A list of soldier skills.

More info: https://openxcom.org/forum/index.php/topic,7974.0.html
| -
|- style="background-color:#ddffdd;"
| '''showTypeInInventory'''
| If set to true, the soldier type will be displayed in the inventory screen.
| false
|- style="background-color:#ddffdd;"
| '''specialWeapon'''
| Allows to define a special weapon on the soldier type (instead of the armor type).

More info: https://openxcom.org/forum/index.php/topic,7859.0.html
| -
|- style="background-color:#ddffdd;"
| '''spawnedSoldier'''
| When "purchasing/hiring" a soldier, you can (optionally) specify overrides for any of the soldier's attributes. Uses the same syntax as the saved games. Cannot override soldier's ID. Cannot override soldier's name if the nationality is overridden (because a new name will be generated).

More info: https://openxcom.org/forum/index.php?topic=12431.0
| -
|}

=== Soldier Transformation ===

<div style="background:#ddffdd;">Defines rules for soldier transformations, listed in ''"soldierTransformation:"''.

Allows doing things like:
* transforming soldiers into MECs
* resurrecting/cloning dead soldiers... useful for streamers/LPers, who want to easily maintain viewer's names
* assigning soldier bonuses
* and much more...

'''More info''': https://openxcom.org/forum/index.php/topic,6331.0.html
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''name'''
| String ID of the soldier transformation type.
| ''required''
|- style="background-color:#ddffdd;"
| '''requires'''
| A list of research projects required before this project appears in the list of available transformations, the default empty list means this project is available from the beginning of the game.
| -
|- style="background-color:#ddffdd;"
| '''requiresBaseFunc'''
| A list of services required at a base in order to do this project, the default empty list means no special services are required.
| -
|- style="background-color:#ddffdd;"
| '''producedItem'''
| The item a soldier should be transformed into. The soldier is completely removed from the game.

Modding tips: sacrifices for special resources/weapons, transform specialists into resources needed to build special facilities, etc.
| -
|- style="background-color:#ddffdd;"
| '''producedSoldierType'''
| The type of soldier produced by this project - any soldier undergoing this transformation will be switched to this type. If left empty, the soldier type does not change.
| -
|- style="background-color:#ddffdd;"
| '''producedSoldierArmor'''
| The armor the soldier will have when the project finishes, only used when '''keepSoldierArmor''' is false. Leaving it empty will give the soldier the default armor for the correspondiing soldier type.
| -
|- style="background-color:#ddffdd;"
| '''keepSoldierArmor'''
| Determines whether or not the soldier will keep the armor they're wearing through this transformation.
| false
|- style="background-color:#ddffdd;"
| '''createsClone'''
| Determines whether the selected soldier has the transformation done to them or a new soldier is created that is a copy of the original and the transformation is done to the new soldier.
| false
|- style="background-color:#ddffdd;"
| '''needsCorpseRecovered'''
| If your project allows dead soldiers, this determines whether or not you needed to have a corpse item available at the end of the battle in which the soldier died. This does not mean you need the corpse item in your stores, just that it would have been recovered if ''recover: true'' was set on the item.
| true
|- style="background-color:#ddffdd;"
| '''allowsDeadSoldiers'''
| Can dead soldiers undergo this transformation? If so, they are brought back to life at the base you started this project in.
| false
|- style="background-color:#ddffdd;"
| '''allowsLiveSoldiers'''
| Can live, non-wounded soldiers undergo this transformation?
| false
|- style="background-color:#ddffdd;"
| '''allowsWoundedSoldiers'''
| Can wounded soldiers undergo this transformation?
| false
|- style="background-color:#ddffdd;"
| '''allowedSoldierTypes'''
| This list determines which soldier types can undergo this transformation, the default empty list means nobody can have this project done to them.
| ''required''
|- style="background-color:#ddffdd;"
| '''requiredPreviousTransformations'''
| A list of transformation projects that must be done to a soldier before they're eligible for this project, the default empty list means no previous projects are required.
| -
|- style="background-color:#ddffdd;"
| '''forbiddenPreviousTransformations'''
| A list of transformation projects that a soldier cannot have undergone in order to be eligible for this project, the default empty list means no previous projects are forbidden.
| -
|- style="background-color:#ddffdd;"
| '''minRank'''
| The minimum rank a soldier must have in order to be eligible for this project, from 0=rookie to 5=commander.
| 0
|- style="background-color:#ddffdd;"
| '''includeBonusesForMinStats'''
| If set to true, soldier bonuses will be included when comparing soldier stats against '''requiredMinStats'''.
| false
|- style="background-color:#ddffdd;"
| '''includeBonusesForMaxStats'''
| If set to true, soldier bonuses will be included when comparing soldier stats against '''requiredMaxStats'''.
| false
|- style="background-color:#ddffdd;"
| '''requiredMinStats'''
| The minimum stats a soldier must have in order to be eligible for this project, defaults to all 0 so any soldier is eligible.
| -
|- style="background-color:#ddffdd;"
| '''requiredMaxStats'''
| The maximum stats a soldier must have in order to be eligible for this project, defaults to all 9999 so any soldier is eligible.
| -
|- style="background-color:#ddffdd;"
| '''requiredItems'''
| A list of items that must be consumed from the base's stores in which you start this project, the default empty list means no items are used.
| -
|- style="background-color:#ddffdd;"
| '''requiredCommendations'''
| A list of commendations (with a minimum decoration level) required to start this project. The default empty list means no commendations are required.

Example: https://openxcom.org/forum/index.php/topic,7405.msg117870.html#msg117870
| -
|- style="background-color:#ddffdd;"
| '''cost'''
| The cost of the project in dollars.
| 0
|- style="background-color:#ddffdd;"
| '''transferTime'''
| Soldiers can be put in a transfer back to the base where they started if this parameter is greater than the default of 0 hours. New clones or resurrected soldiers are automatically given a transfer to the base with a default of 24 hours.
| 0
|- style="background-color:#ddffdd;"
| '''recoveryTime'''
| The amount of wound recovery time a soldier is given after this project completes and the transfer, if any, is completed. The default value is 0 days.
| 0
|- style="background-color:#ddffdd;"
| '''flatOverallStatChange'''
| A direct change to the soldier's overall stats when undergoing this project, can be positive or negative - tu: 5 means the soldier will gain 5 max time units, while tu: -5 means the soldier will lose 5 max time units. The default of 0 means no change.
| -
|- style="background-color:#ddffdd;"
| '''flatMin'''<br>
'''flatMax'''
| Similar to '''flatOverallStatChange''', but allows to specify a range from which the game chooses randomly.

More info: https://openxcom.org/forum/index.php/topic,7196.msg117768.html#msg117768
| -
|- style="background-color:#ddffdd;"
| '''percentOverallStatChange'''
| A percent change to the soldier's overall stats when undergoing this project, can be positive or negative - tu: 5 means the soldier will gain an extra 5% of their max time units, while tu: -5 means the soldier will lose 5% of their max time units. The default of 0 means no change.
| -
|- style="background-color:#ddffdd;"
| '''percentMin'''<br>
'''percentMax'''
| Similar to '''percentOverallStatChange''', but allows to specify a range from which the game chooses randomly.
| -
|- style="background-color:#ddffdd;"
| '''percentGainedStatChange'''
| A percent change to the soldier's stats, but instead of taking a portion of the overall stats, this only applies to the stats they've trained up from their initial values, can be positive or negative - firing: -100 means the soldier will lose all of the firing accuracy they trained since joining, while firing: 10 means they gain 10% of the amount they trained over their initial values. The default of 0 means no change.
| -
|- style="background-color:#ddffdd;"
| '''percentGainedMin'''<br>
'''percentGainedMax'''
| Similar to '''percentGainedStatChange''', but allows to specify a range from which the game chooses randomly.
| -
|- style="background-color:#ddffdd;"
| '''showMinMax'''
| If enabled, the GUI will show random improvement as min/max range. If disabled, it will show just a question mark.
| false
|- style="background-color:#ddffdd;"
| '''rerollStats'''
| This attribute allows you to specify, which stats should be completely re-rolled.

More info: https://openxcom.org/forum/index.php/topic,7196.msg117767.html#msg117767
| false
|- style="background-color:#ddffdd;"
| '''lowerBoundAtMinStats'''
| Determines whether or not any changes in stats from this project should go below the minStats defined on the new soldier type.
| true
|- style="background-color:#ddffdd;"
| '''upperBoundAtMaxStats'''
| Determines whether or not any changes in stats from this project should go above the maxStats defined on the new soldier type.
| false
|- style="background-color:#ddffdd;"
| '''upperBoundAtStatCaps'''
| Determines whether or not any changes in stats from this project should go above the statCaps defined on the new soldier type.
| false
|- style="background-color:#ddffdd;"
| '''upperBoundType'''
| Determines how strictly to apply '''upperBoundAtMaxStats''' and '''upperBoundAtStatCaps'''. Possible values:
* 0 = dynamic (i.e. soft when not changing the soldier type; hard when changing the soldier type)
* 1 = soft (if the soldier is already above the maximum before the transformation, don't reduce his overflown stats)
* 2 = hard (always reduce if above the maximum)
| 0


|- style="background-color:#ddffdd;"
| '''removeTransformations'''
| A list of (potential) previous soldier transformations to remove when undergoing this project.

More info: https://openxcom.org/forum/index.php?topic=12749.0
| -
|- style="background-color:#ddffdd;"
| '''reset'''
| The reset flag can be used to clear the bonuses gained by previous transformations. It also clears the list of previously performed transformations.

For example:
1. you train karate and gain a bonus
2. then you transform the guy into a MEC and want to lose all the previous bonuses (since MECs can't benefit from karate training... I hope)

Note: stats gained by "classic" transformations (i.e. those that are NOT bonuses) will NOT be reset; only bonuses can be reset
| false
|- style="background-color:#ddffdd;"
| '''resetRank'''
| Reset the soldier rank back to Rookie during the transformation?
| false
|- style="background-color:#ddffdd;"
| '''soldierBonusType'''
| ID of a soldier bonus applied to a soldier undergoing this transformation.
| -
|}

=== Soldier Bonuses ===

<div style="background:#ddffdd;">
Defines rules for soldier bonuses, listed in ''"soldierBonuses:"''.

Bonuses can be manually awarded by the player via '''soldier transformations'''; or automatically awarded together with a '''soldier commendations/medals'''.

'''More info''': https://openxcom.org/forum/index.php/topic,7405.0.html
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''name'''
| String ID of the soldier bonus type.
| ''required''
|- style="background-color:#ddffdd;"
| '''visibilityAtDark'''
| Defines the bonus to night vision (in tiles). Cannot go beyond global maximum view distance.
| 0
|- style="background-color:#ddffdd;"
| '''visibilityAtDay'''
| Defines the bonus to day vision (in tiles). Cannot go beyond global maximum view distance.
| 0
|- style="background-color:#ddffdd;"
| '''psiVision'''
| Defines the bonus to psi vision (in tiles).
| 0
|- style="background-color:#ddffdd;"
| '''heatVision'''
| Defines the bonus to <u>visibility through smoke</u> (also called heat vision).
| 0
|- style="background-color:#ddffdd;"
| '''visibilityThroughFire'''
| Defines the bonus to <u>visibility through fire</u>.
| 0
|- style="background-color:#ddffdd;"
| '''frontArmor'''
| Defines the bonus (or malus) to front armor.
| 0
|- style="background-color:#ddffdd;"
| '''sideArmor'''
| Defines the bonus (or malus) to left and right side armor.
| 0
|- style="background-color:#ddffdd;"
| '''leftArmorDiff'''
| Defines the bonus (or malus) to left side armor. Stacks with '''sideArmor'''.
| 0
|- style="background-color:#ddffdd;"
| '''rearArmor'''
| Defines the bonus (or malus) to rear armor.
| 0
|- style="background-color:#ddffdd;"
| '''underArmor'''
| Defines the bonus (or malus) to under armor.
| 0
|- style="background-color:#ddffdd;"
| '''stats'''
| Defines the bonus to soldier's stats (same way as the armor can). Can go even beyond any cap/maximum.
| -
|- style="background-color:#ddffdd;"
| '''recovery'''
| Defines the bonus to soldier's resource recovery every turn (same way as the armor can). Affects time units, energy, health, stun, morale and mana.
| -
|}

=== Soldier Skillls ===

<div style="background:#ddffdd;">
Defines rules for soldier skills, listed in ''"skills:"''.

'''More info''': https://openxcom.org/forum/index.php/topic,7974.0.html
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the soldier skill type.
| ''required''
|- style="background-color:#ddffdd;"
| '''targetMode'''
| Target mode for the skill. Possible options:
* 0 = No target needed (just activation, script takes over) - BA_NONE
* 10  = Melee-range targeting (1 tile) - BA_HIT
* 7,8,9 = Firearm ranged targeting - BA_AUTO = 7, BA_SNAP = 8, BA_AIMED = 9
* 11,13,14 = Psi targeting (with or without LOS) - BA_USE = 11, BA_MINDCONTROL = 13, BA_PANIC = 14
* 6 = Thrown targeting - BA_THROW
* 12 = Waypoint targeting - BA_LAUNCH
| 0
|- style="background-color:#ddffdd;"
| '''isPsiRequired'''
| Is Psi Skill required for this skill to work?
| false
|- style="background-color:#ddffdd;"
| '''requiredBonuses'''
| Defines the list of required soldier bonuses for this skill.
| -
|- style="background-color:#ddffdd;"
| '''costUse'''
| Defines the use cost for this skill.
| -
|- style="background-color:#ddffdd;"
| '''flatUse'''
| Defines the flat vs. percentage cost flags for the use cost of this skill.
| -
|- style="background-color:#ddffdd;"
| '''compatibleWeapons'''
| Defines the list of weapons which are compatible with this skill.
| -
|- style="background-color:#ddffdd;"
| '''checkHandsOnly'''
| Should the check for compatible items (using '''compatibleWeapons''') only consider the hands (or also the inventory and specialweapon)?
| true
|- style="background-color:#ddffdd;"
| '''battleType'''
| Defines the battle type of compatible items (0-11). E.g. 1=firearm, 3=melee weapon, 9=psiamp, etc.

This is used as fall-back if no '''compatibleWeapons''' are specified or found.
| -
|- style="background-color:#ddffdd;"
| '''checkHandsOnly2'''
| Should the check for compatible items (using '''battleType''') only consider the hands (or also the inventory and specialweapon)?
| false
|}

=== Soldier Commendations ===

A commendation is constructed using the following arguments:

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- 
| '''type'''
| This is a string containing the name of the commendation.
| -
|- 
| '''description'''
| This is a string containing the description of the commendation.
| -
|- style="background-color:#ddffdd;"
| '''requires'''
| Commendation's research requirements.
| -
|- style="background-color:#ddffdd;"
| '''units'''
| A list of soldier types, which can be awarded this commendation.
| -
|- 
| '''sprite'''
| This is an int corresponding to the sprite of the commendation. If the integer does not correspond to a sprite, the game will crash.
| -

|- style="background-color:#ddffdd;"
| '''missionMarkerFilter'''
| A list of mission marker names. Used to filter missions when combined with the '''totalMissions''' criteria.

More info: https://openxcom.org/forum/index.php/topic,10190.msg142628.html#msg142628
| -
|- style="background-color:#ddffdd;"
| '''missionTypeFilter'''
| A list of mission types. Used to filter missions when combined with the '''totalMissions''' criteria.
| -
|- style="background-color:#ddffdd;"
| '''soldierBonusTypes'''
| A list of soldier bonus types per decoration level.

More info: https://openxcom.org/forum/index.php/topic,7405.msg116840.html#msg116840
| -


|- 
| '''criteria'''
| Commendation criteria are controlled by SoldierDiary.cpp, and function by iterating over the game's record of every takedown a soldier has performed. There are three kinds of criteria: Scalar Criteria, Noun Criteria, and Kill Criteria. If the criteria is a Kill Criteria, there needs to be more details added via killCriteria. 

The vector of integers cannot exceed 10 in length, unless more decoration sprites are added. The list may be shorter, if the commendation does not have as many decorations. The integers can also repeat, in order to skip decorations.

First integer corresponds to an award, with no decoration.
Second corresponds to 1 bronze star.
Third corresponds to 2 bronze stars.
Fourth corresponds to 3 bronze stars.
Fifth corresponds to 1 silver star.
Sixth corresponds to 2 silver stars.
Seventh corresponds to 3 silver stars.
Eighth corresponds to 1 gold star.
Ninth corresponds to 2 gold stars.
Tenth corresponds to 3 gold stars.

Example: This criteria has 3 decoration levels: 1 bronze star, 2 silver stars, 3 gold stars. 
    criteria:
        totalAllAliensKilled: [1, 1, 2, 2, 2, 2, 3, 3, 3, 3]
| -
|- 
| '''killCriteria'''
| This is the extra detail required by killsWithCriteriaCareer, killsWithCriteriaMission, or killsWithCriteriaTurn. The valid details are listed in the table under ''Kill Criteria''.

Example: This killCriteria can be awarded for two reasons: if the soldier kills one sectopod terrorist with a grenade OR if the soldier kills one cyberdisc terrorist with a grenade.
    killCriteria:
        -
            1: ["STR_SECTOPOD_TERRORIST", "STR_LIVE_TERRORIST", "STATUS_DEAD", "BT_GRENADE"]
        - 
            1: ["STR_CYBERDISC_TERRORIST", "STR_LIVE_TERRORIST", "STATUS_DEAD", "BT_GRENADE"]

Example: This killCriteria is awarded for one reason: if the soldier has killed one hostile cyberdisc terrorist AND if the soldier has killed one hostile reaper terrorist.
    killCriteria:
        -
            1: ["STR_CYBERDISC", "STR_LIVE_TERRORIST", "FACTION_HOSTILE", "STATUS_DEAD"]
            1: ["STR_REAPER", "STR_LIVE_TERRORIST", "FACTION_HOSTILE", "STATUS_DEAD"]
| -
|- 
|}

Full example 1: 
  - type: STR_MEDAL_FLANKSHOT_NAME
    description: STR_MEDAL_FLANKSHOT_DESCRIPTION
    sprite: 43
    criteria:
      killsWithCriteriaCareer: [3, 6, 9, 9, 9, 9, 12, 12, 12, 12]
    killCriteria:
      -
        1: ["SIDE_LEFT", "FACTION_HOSTILE", "STATUS_DEAD"]
      -
        1: ["SIDE_RIGHT", "FACTION_HOSTILE", "STATUS_DEAD"]

Full example 2:
  - type: STR_MEDAL_MERCY_CROSS_NAME
    description: STR_MEDAL_MERCY_CROSS_DESCRIPTION
    sprite: 35
    criteria:
      totalAllAliensStunned: [1, 1, 2, 2, 2, 2, 3, 3, 3, 3]

''Scalar Criteria'' depend only on one number, and are generally the number of times some specific event has occured in a soldier's career:

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- 
| '''totalKills'''
| Total number of kills earned by the soldier.
| -
|- 
| '''totalMissions'''
| Total number of missions in which the soldier participated.
| -
|- 
| '''totalWins'''
| Total number of missions in which the soldier victorious.
| -
|- 
| '''totalScore'''
| Total score earned by the soldier.
| -
|- 
| '''totalStuns'''
| Total number of hostile enemies stunned by the soldier.
| -
|- 
| '''totalBaseDefenseMissions'''
| Total number of base defense missions in which the soldier was victorious.
| -
|- 
| '''totalTerrorMissions'''
| Total number of terror missions in which the soldier was victorious.
| -
|- 
| '''totalNightMissions'''
| Total number of night missions in which the soldier was victorious. (Excludes base defense missions and alien base missions.)
| -
|- 
| '''totalNightTerrorMissions'''
| Total number of night terror missions in which the soldier was victorious.
| -
|- 
| '''totalMonthlyService'''
| Total number of months served by the soldier.
| -
|- 
| '''totalFellUnconcious'''
| Total number of missions in which the soldier has fallen unconcious.
| -
|- 
| '''totalShotAt10Times'''
| Total number of times a soldier was shot at in a mission, counted 10 at a time.

Example: On mission 1, the soldier was shot at 23 times; this increments the total twice. On mission 2, the soldier was shot at 18 times; this increments the total once. The total is three, not four, despite being shot at 41 times.
| -
|- 
| '''totalHit5Times'''
| Total number of times a soldier was hit in a mission, counted 10 at a time.

Example: On mission 1, the soldier was shot 8 times; this increments the total once. On mission 2, the soldier was shot 4 times; this does not increment the total. The total is one, not two, despite being shot 12 times.
| -
|- 
| '''totalFriendlyFired'''
| Total number of times this soldier was shot by a friendly soldier. Does not count if the soldier is KIA or MIA.
| -
|- 
| '''total_lone_survivor'''
| Total number of missions in which a soldier was the only survivor. 

Only awarded if this soldier was deployed with other soldiers, and that this soldier did not kill any friendly soldiers.
| -
|- 
| '''totalIronMan'''
| Total number of missions this soldier has done alone.
| -
|- 
| '''totalImportantMissions'''
| Total number of non-UFO crash recovery missions in which the soldier was victorious.
| -
|- 
| '''totalLongDistanceHits'''
| Total number of shots by the soldier that hit a target that was more than 30 tiles away.
| -
|- 
| '''totalLowAccuracyHits'''
| Total number of shots by the soldier that hit a target who was futher away than the weapon's firing accuracy. 
| -
|- 
| '''totalReactionFire'''
| Total number of kills earned by the soldier that occured on the hostile turn, where the weapon was not a grenade or a proximity grenade.
| -
|- 
| '''totalTimesWounded'''
| Total number of missions in which the soldier was wounded.
| -
|- 
| '''totalDaysWounded'''
| Total number of days the soldier spent wounded.
| -
|- 
| '''totalValientCrux'''
| Total number of missions in which the soldier was victorious, saved at least one civilian, and lost no civilians.
| -
|- 
| '''isDead'''
| Total number of missions in which the soldier died. 
| -
|- 
| '''totalTrapKills'''
| Total number of kills earned by the soldier that occured on the hostile turn, where the weapon was a grenade, a proximity grenade, or a weapon with no BattleType.
| -
|- 
| '''totalAlienBaseAssaults'''
| Total number of alien base missions in which the soldier was victorious.
| -
|- 
| '''totalAllAliensKilled'''
| Total number of missions in which the soldier was victorious and the soldier killed every alien that died (at least one), and stunned every alien that was stunned.
| -
|- 
| '''totalAllAliensStunned'''
| Total number of missions in which the soldier was victorious and the soldier stunned every alien that was stunned (at least one), and no aliens were killed.
| -
|- 
| '''totalWoundsHealed'''
| Total number of times the soldier applied healing in the medikit.
| -
|- 
| '''totalAllUFOs'''
| Value is 1 if the soldier participated in a mission against a UFO of each type.
| -
|- 
| '''totalAllMissionTypes'''
| Value is 1 if the soldier participated in a mission of each type.
| -
|- 
| '''totalStatGain'''
| Sum of all stat gains for the soldier. Bravery stat gains are divided by 10.
| -
|- 
| '''totalRevives'''
| Total number of times this soldier revived another unit. The unit can hostile, friendly or neutral.
| -
|- 
| '''totalSoldierRevives'''
| Total number of times this soldier revived another unit that started as friendly.
| -
|- 
| '''totalHostileRevives'''
| Total number of times this soldier revived another unit that started as hostile.
| -
|- 
| '''totalNeutralRevives'''
| Total number of times this soldier revived another unit that started as neutral.
| -
|- 
| '''totalWholeMedikit'''
| Total number of times this soldier used one of each medikit functions. 

Example: If in a single mission the soldier healed wounds 3 times, applied stimulant 2 times, and applied painkillers 4 times, then the total would increment by 2.
| -
|- 
| '''totalBraveryGain'''
| Sum of all bravery stat gains for the soldier. The stat is not divded by 10 here.
| -
|- 
| '''bestOfRank'''
| If, upon death, this soldier had the highest score of any dead soldier of the same rank, the value of bestOfRank is equal to the score of the dead soldier. Otherwise it is 0.
| -
|- 
| '''bestSoldier'''
| If, upon death, this soldier had the highest score of any dead soldier, the value of bestSoldier is True. Otherwise it is False.
| -
|- 
| '''isMIA'''
| Total number of missions in which the soldier was left behind. 
| -
|- 
| '''totalMartyrKills'''
| Total number of kills earned by the soldier that occured on the same turn that the soldier killed him or herself, to a maximum of 10 per mission.
| -
|- 
| '''totalPostMortemKills'''
| Total number of kills earned by the soldier that occured after the soldier died.
| -
|- 
| '''globeTrotter'''
| Value is True is the soldier has participated in a mission that occured in each country.
| -
|- 
| '''totalSlaveKills'''
| Total number of kills earned by the soldier via mind-control of another unit.
| -
|-
|}

''Noun Criteria'' function like scalar criteria, but keep separate tallies for each noun. They are incompatible with each other. If used together, the commendation will be given out repeatedly.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- 
| '''totalKillsWithAWeapon'''
| Total number of kills with a specific weapon earned by the soldier.
| -
|-
| '''totalMissionsInARegion'''
| Total number of missions in a specific region in which the soldier participated.
| -
|-
| '''totalKillsByRace'''
| Total number of kills of a specific race earned by the soldier.
| -
|-
| '''totalKillsByRank'''
| Total number of kills of a specific rank earned by the soldier.
| -
|-
|}

''Kill Criteria'' offer more control over the kinds of kills that which can be commended. Kill Criteria can consist of the following:
* any race, rank, weapon, ammo (referenced by string for maximum moddability), 
* one of these statuses: STATUS_DEAD and STATUS_UNCONSCIOUS,
* STATUS_PANICKED for a unit that has been psi-panicked,
* STATUS_TURNING for a unit that has been mind controlled,
* one of these factions: FACTION_HOSTILE, FACTION_NEUTRAL, FACTION_PLAYER,
* one of these battle types: BT_FIREARM, BT_AMMO, BT_MELEE, BT_GRENADE, BT_PROXIMITYGRENADE, BT_MEDIKIT, BT_SCANNER, BT_MINDPROBE, BT_PSIAMP, BT_FLARE, BT_CORPSE,
* one of these damage types: DT_AP, DT_IN, DT_HE, DT_LASER, DT_PLASMA, DT_STUN, DT_MELEE, DT_ACID, DT_SMOKE,
* one of these sides: SIDE_FRONT, SIDE_LEFT, SIDE_RIGHT, SIDE_REAR, SIDE_UNDER,
* one of these body parts: BODYPART_HEAD, BODYPART_TORSO, BODYPART_RIGHTARM, BODYPART_LEFTARM, BODYPART_RIGHTLEG, BODYPART_LEFTLEG.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- 
| '''killsWithCriteriaCareer'''
| Total number of kills across a soldier's career that meet the specified criteria.
| -
|-
| '''killsWithCriteriaMission'''
| Total number of kills across a single mission of a soldier that meet the specified criteria.
| -
|-
| '''killsWithCriteriaTurn'''
| Total number of kills across a single turn of a soldier that meet the specified criteria.
| -
|-
|}

<div style="background:#ddffdd;">
In OXCE, you can also use soldier commendations to assign soldier bonuses (see above).
Bonuses are defined per decoration level.
You don't need to define all decoration levels... if a soldier has a higher decoration level than defined, the highest available is used.

More info: https://openxcom.org/forum/index.php/topic,7405.msg116840.html#msg116840

Example:

  commendations:
    - type: STR_MEDAL_ALIENS_KILLED
      description: STR_MEDAL_ALIENS_KILLED_DESCRIPTION
      sprite: 1
      soldierBonusTypes: [STR_KILL1, STR_KILL2, STR_KILL3, STR_KILL4]           # various bonuses for various decoration levels
      criteria:
        killsWithCriteriaCareer: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
      killCriteria:
        -
          - [1, ["STATUS_DEAD", "FACTION_HOSTILE"]]

</div>
[[Criteria and KillCriteria Details]]

=== AI Units (Aliens/Civilians) ===

Defines an [[Alien Life Forms|alien]] (enemy) or [[civilian]] (neutral) unit, listed in ''"units:"''. Every different alien rank is a different unit, since they have completely different stats. Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]]
* [https://openxcom.org/forum/index.php/topic,7241.0.html mana] - OXCE only

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the unit name.
| ''required''
|-
| '''race'''
| String ID of the unit race (for alien units).
| -
|-
| '''rank'''
| String ID of the unit rank (for alien units).
| -
|- style="background-color:#ddffdd;"
| '''spotter'''
| The spotter score. Determines how many turns sniper AI units can act on this unit seeing your troops.
| 0
|- style="background-color:#ddffdd;"
| '''sniper'''
| The sniper score. Determines the chances of firing from out of LOS on spotted units.
| 0
|-
| '''stats'''
| Battlescape stats of this unit.
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this unit uses by default.
| ''required''
|-
| '''standHeight'''
| Height of this unit when standing.
| 0
|-
| '''kneelHeight'''
| Height of this unit when kneeling. Not supported in OpenXcom yet, for future use?
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''value'''
| [[Score]] this unit is worth.
| 0
|- style="background-color:#ddffdd;"
| '''cosmetic'''
| Is this unit ignored in soldier diaries and commendations?

More info: https://openxcom.org/forum/index.php/topic,10352.0.html
| false
|- style="background-color:#ddffdd;"
| '''ignoredByAI'''
| Is this unit ignored by the AI?

More info: https://openxcom.org/forum/index.php/topic,10353.0.html
| false
|- style="background-color:#ddffdd;"
| '''vip'''
| Is this unit a VIP? Used for "Escort the VIP" and "Protect the VIP" mission types.
| false
|- style="background-color:#ddffdd;"
| '''civilianRecoveryType'''
| Gets the type of staff (soldier/engineer/scientists) or type of item to be recovered when a civilian (or a player-controlled summoned unit) is saved.

Since OXCE v7.10 it can be used also on aliens.
| -
|- style="background-color:#ddffdd;"
| '''spawnedPersonName'''
| When "recovering" a soldier, you can (optionally) specify also his/her name. The name is translatable.
| -
|- style="background-color:#ddffdd;"
| '''spawnedSoldier'''
| When "recovering" a soldier, you can (optionally) specify overrides for any of the soldier's attributes. Uses the same syntax as the saved games. Cannot override soldier's ID and name.
| -
|-
| '''intelligence'''
| Intelligence of this unit's AI. The higher the value, the longer this unit remembers player troops between turns.
| 0
|- style="background-color:#ddffdd;"
| '''waitIfOutsideWeaponRange'''
| Should the unit get "stuck" trying to fire from outside of weapon range? OXC bug, that may serve as "feature" in rare cases.

Note: the default value is to fix the OXC bug.
| false
|- style="background-color:#ddffdd;"
| '''canPanic'''
| Can this unit be targeted with a psi panic attack?
| true
|- style="background-color:#ddffdd;"
| '''canBeMindControlled'''
| Can this unit be targeted with a psi mind control attack?
| true
|- style="background-color:#ddffdd;"
| '''berserkChance'''
| Chance that a panicked unit berserks. The complement corresponds to fleeing/freezing chance.

Since OXCE 8.1, there is also a special value -1, which corresponds to probability exactly one third (i.e. 33.33333...%).
| -1
|- style="background-color:#ddffdd;"
| '''canSurrender'''
| Can this unit surrender?
| false
|- style="background-color:#ddffdd;"
| '''autoSurrender'''
| Does this unit surrender automatically, if all other units surrendered too?
| false
|-
| '''aggression'''
| Aggression of this unit's AI. The higher the value, the more ruthless the unit, the more likely to make a frontal/melee assault. Less aggressive units tend to set up ambushes.
Possible values are:
* 0 = mostly passive
* 1 = balanced
* 2+ = mostly aggressive (meaningful values are between 2 and 8)
| 0
|- style="background-color:#ddffdd;"
| '''isLeeroyJenkins'''
| Unit marked as "leeroy" must have a melee weapon (and be able to use it). It will completely ignore vanilla AI "decision making" and run around (using vanilla patrol routine) until it spots someone and then charge at the nearest target (if multiple spotted).

Charge is mostly vanilla/OXCE, with the following differences:
* ignore remaining TUs (charge even if not enough TUs to attack now); since OXCE v6.9 charging can happen also over multiple turns
* ignore dangerous tiles (grenades? pfff!)
* ignore OXCE melee dodge (leeroy is not intelligent enough to attack from behind)
| false
|-
| '''energyRecovery'''
| Energy recovered by the unit each turn.
| 30
|-
| '''specab'''
| Special ability of this unit:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]] (Requires '''power''' and '''blastRadius''' properties to be set on the corpse)
* 2 = [[Silacoid|Burns Floor]]
* 3 = [[Bio-Drone|Burns Floor and explodes on Death]]

Note: Explodes on Death refers to when the unit is collapsing. This can be either be due to the unit not having any remaining HPs or that the stun level exceeds its HP. Only when the damageType is set to DT_STUN, DT_HE, DT_IN or DT_MELEE (OpenXcom) or the value for damageAlter '''IgnoreSelfDestruct''' on the damaging item is set to true (OpenXcom Extended), the unit will '''not''' explode.
| 0
|-
| '''spawnUnit'''
| String ID of the unit used to respawn on death (e.g. [[Zombie]]s respawn as [[Chrysallid]]s).
| -
|-
| '''livingWeapon'''
| Is this unit a living weapon?
If yes, it ignores any weapon loadout associated with its rank in the alien deployment and only attacks with a weapon derived from its race name (must be marked as '''fixedWeapon'''). The weapon's name is the unit's race name without the first 4 letters (STR_) and with a suffix (_WEAPON). For example: STR_REAPER => REAPER_WEAPON.
| false
|-
| '''meleeWeapon'''
| This unit's built-in melee weapon (e.g. Lobsterman's Claws). Does not appear in the inventory.
| -
|-
| '''psiWeapon'''
| This unit's built-in psi weapon. Ignored if the unit doesn't have any psi skill. Does not appear in the inventory.
| ALIEN_PSI_WEAPON
|-
| '''capturable'''
| Can this unit be captured alive?

Note: units which cannot be captured alive are insta-killed when they fall unconscious.
| true
|- style="background-color:#ddffdd;"
| '''liveAlien'''
| String ID of the item that will be used to represent the live/captured alien in the base/geoscape.

Notes:
* OXC compatibility: by default '''liveAlien''' is the same as '''type''' (but only if such an item exists)
* you can use an empty string '''""''' to explicitly indicate that there is no live alien
| ~
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. Game will pick one set "at random" (randomness comes from the current alien tech level definition). These weapons WILL appear in inventory slots (references items).
| -
|- style="color:#666666;"
| '''builtInWeapons'''
| ''Deprecated:'' use '''builtInWeaponSets''' instead.
| -
|- style="background-color:#ddffdd;"
| '''weightedBuiltInWeaponSets'''
| Adds support for randomized (weighted) unit built-in weapon sets.

More info here: https://openxcom.org/forum/index.php?topic=12065.0
| -
|- style="background-color:#ddffdd;"
| '''moraleLossWhenKilled'''
| Percentage modifier for morale loss when this unit is killed.

Tip: set for example 50% for cannon fodder and 300% for VIPs. 
| 100
|-
| '''deathSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit dies. No value means no sound upon death. A list of sound IDs can be used too, the game then chooses one randomly each time.
| - 
|- style="background-color:#ddffdd;"
| '''selectUnitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit is manually selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''startMovingSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit starts moving. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''selectWeaponSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit's weapon is selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''annoyedSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit is repeatedly manually selected. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''panicSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit panics. A list of sound IDs can be used too.
| - 
|- style="background-color:#ddffdd;"
| '''berserkSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit berserks. A list of sound IDs can be used too.
| - 
|-
| '''aggroSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit aggros.
<span style="background:#ddffdd;">
In OXCE, a list of sound IDs can be used too, the game then chooses one randomly each time.
</span>
| -1
|-
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit moves.
| -1
|- style="background-color:#ddffdd;"
| '''showFullNameInAlienInventory'''
| Defines whether the [Alien Inventory] screen (accessible via middle-click on a unit) should display a unit's type/name or just a unit's race.

Possible options:
* -1 = use global setting (show the race by default)
* 0 = show the race (e.g. Sectoid)
* 1 = show the type (e.g. Sectoid Leader)
| -1
|- style="background-color:#ddffdd;"
| '''pickUpWeaponsMoreActively'''
| Allows AI to pick up weapons more actively. More info: https://openxcom.org/forum/index.php/topic,6882.0.html

Possible options:
* -1 = use global setting (disabled by default)
* 0 = disabled
* 1 = enabled
| -1
|- style="background-color:#ddffdd;"
| '''avoidsFire'''
| Allows AI to not be afraid to pathfind through fire. More info: https://openxcom.org/forum/index.php/topic,11212.0.html

Possible options:
* false = can pathfind through fire without problems
* true = can pathfind through fire, but with a big penalty (usually this results in not walking through fire)

If not defined, vanilla algorithm is used, which allows pathfinding through fire to units with '''specab: 2''' (e.g. Silacoid) and '''specab: 3''' (e.g. Bio-Drone).
| vanilla
|}

=== Alien Races ===

Defines a [[Alien Life Forms|race]] used in [[Alien Missions]], listed in ''"alienRaces:"''. Heavily tied with deployment data.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| String ID of the alien race name.
| ''required''
|-
| '''members'''
| Alien crew associated with this alien race (e.g. race units + terrorist units), defined by a list of unit string IDs. Order here will define rank in terms of deployment. Generally speaking the order is:
* 0 - Commander
* 1 - Leader
* 2 - Engineer
* 3 - Medic
* 4 - Navigator
* 5 - Soldier
* 6 - Terrorist 1
* 7 - Terrorist 2
but of course, not all races have all ranks, so the "fill in" rank would be listed multiple times (see Ethereals).
| -
|- style="background-color:#ddffdd;"
| '''membersRandom'''
| Alternative to '''members'''. Instead of defining just a single unit type per alien rank, you can define any number of unit types here and one will be chosen randomly (each time a new unit is generated). To increase a chance of a certain unit type being selected, you can add it multiple times.
| -
|- style="background-color:#ddffdd;"
| '''retaliationMissionWeights'''
| A weighted list of alien missions that can be generated after a dogfight against this race, listed by "number of months passed".

More info: https://openxcom.org/forum/index.php/topic,9496.0.html
| -
|- style="background-color:#ddffdd;"
| '''retaliationAggression'''
| A flat percentage to modify the dogfight retaliation odds for this race. Positive value increases odds, negative value decreases odds.
Example: Normal retaliation odds for Veteran difficulty (in UFO) are 12%. If this number is set to 20, the odds will increase to 32%.
| 0
|- style="background-color:#ddffdd;"
| '''baseCustomMission'''
| String ID of an alien deployment ('''not alien mission!!''') override for all alien bases inhabited by this alien race.

Applies to:
* all starting condition checks
* additional mission description, see '''alertDescription'''
* everything done during the Battlescape generation
* everything done during the Debriefing

Does '''not''' apply to anything else (that depends on alien deployment), for example:
* alien base supply mission
* alien base hunt missions
* alien base upgrades
* etc.
| -
|- style="background-color:#ddffdd;"
| '''baseCustomDeploy'''
| A lighter version of '''baseCustomMission''', which only overrides the [[#Deployment Data|deployment data]] used during the Battlescape generation.

Note: if both '''baseCustomMission''' and '''baseCustomDeploy''' are specified, [[#Deployment Data|deployment data]] is taken from '''baseCustomDeploy''' and everything else is taken from '''baseCustomMission'''.
| -
|}

=== Alien Deployments ===

Defines a Battlescape deployment data used in [[Alien Missions]] (such as alien and map configurations), listed in ''"alienDeployments:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the deployment name.
| ''required''
|- style="background-color:#ddffdd;"
| '''isHidden'''
| If enabled, the mission will not appear in the mission list in New Battle GUI. Doesn't work when debug is enabled in options.cfg.

Since OXCE 7.6 there is also a special use for craft preview, more details: https://openxcom.org/forum/index.php/topic,10370.msg147475.html#msg147475
| false
|- style="background-color:#ddffdd;"
| '''forcePercentageOutsideUfo'''
| If enabled, the '''percentageOutsideUfo''' parameter will be forced also for this alien deployment (normally it only applies to UFO landing/crash sites).
| false
|- style="background-color:#ddffdd;"
| '''customUfo'''
| String ID of a UFO to be used in mapscripts in addUFO command. This allows to reuse the same script for many deployments.

More info: https://openxcom.org/forum/index.php/topic,7631.0.html
| -
|- style="background-color:#ddffdd;"
| '''startingCondition'''
| String ID of a [[#Battle Starting Conditions|starting condition]] for missions using this deployment.

Note: overrides any globe texture starting condition.
| -
|- style="background-color:#ddffdd;"
| '''enviroEffects'''
| String ID of [[#Battle Enviro Effects|enviro effects]] for missions using this deployment.

Note: overrides any mission terrain enviro effects.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below [[#Deployment Data|Deployment Data]]).
| -
|- style="background-color:#ddffdd;"
| '''reinforcements'''
| List of scripted reinforcement waves (see below [[#Reinforcements Script|Reinforcements Script]]).
| -
|-
| '''width'''
| Width of the Battlescape map in grid units.
| 0
|-
| '''length'''
| Length of the Battlescape map in grid units.
| 0
|-
| '''height'''
| Vertical height of the Battlescape map in grid units.
| 0
|-
| '''civilians'''
| Maximum number of civilians to spawn. The actual number of civilians spawned will be between 50-100% of the specified maximum.
| 0
|- style="background-color:#ddffdd;"
| '''ignoreLivingCivilians'''
| If true, living civilians are ignored in the Debriefing. They don't count as saved, if xcom wins. And they don't count as killed, if aliens win.

More info: https://openxcom.org/forum/index.php?topic=12389.0
| false
|- style="background-color:#ddffdd;"
| '''civilianSpawnNodeRank'''
| Map node rank to spawn civilians on.

More info: https://openxcom.org/forum/index.php/topic,6477.0.html
| 0
|- style="background-color:#ddffdd;"
| '''civiliansByType'''
| A list of additional civilians to spawn, each list item is defined by a civilian type ID and a maximum number (type: number). The actual number of civilians spawned will be again between 50-100% of the specified maximum, but this time the 50% is rounded up (for '''civilians''' attribute it is rounded down).
| -
|-
| '''terrains'''
| List of string IDs of the [[#Terrains|terrains]] to choose from when generating the map. Not used for UFO land/crash sites, terrain comes from the Geoscape globe texture.
| -
|-
| '''shade'''
| Shade of the map (0-15, where 0 is full daytime and 15 is full nighttime). If not specified (e.g. for UFO land/crash sites), the shade comes from the Geoscape globe.
| -1
|- style="background-color:#ddffdd;"
| '''minShade'''
| Minimum shade of the map (0-15). Used only when '''shade''' is not set, to adjust the shade coming from the Geoscape globe.
| -1
|- style="background-color:#ddffdd;"
| '''maxShade'''
| Maximum shade of the map (0-15). Used only when '''shade''' is not set, to adjust the shade coming from the Geoscape globe.
| -1
|-
| '''nextStage'''
| String ID of the next deployment stage to use after this one, for multi-stage missions.
| -
|-
| '''race'''
| Sets (overrides) the alien race to use when generating the map.
| -
|- style="background-color:#ddffdd;"
| '''randomRace'''
| Sets (overrides) the alien race to use when generating the map. Unlike '''race''' attribute, this is a list of multiple possible races; one is chosen randomly at runtime.
| -
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| false
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''abortCutscene'''
| Sets the cutscene to play when you abort the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''script'''
| Map script used to generate the map (overrides the map script from terrain definition).
| -
|- style="background-color:#ddffdd;"
| '''mapScripts'''
| List of map scripts used to generate the map (overrides '''script''' and any of the map scripts from terrain definition). One is chosen at random during map generation.
| -
|-
| '''alert'''
| String ID of the message to display in the alert popup when this mission spawns on the Geoscape.
| STR_ALIENS_TERRORISE
|-
| '''alertBackground'''
| String ID of the background image to use in the alert popup when this mission spawns on the Geoscape.
| BACK03.SCR
|- style="background-color:#ddffdd;"
| '''alertDescription'''
| String ID of the additional mission description (displayed when clicking on the [Info] button on the [Target Info] screen).
| -
|- style="background-color:#ddffdd;"
| '''alertSound'''
| Sound ID from GEO.CAT to be played when the [Mission Detected] screen pops up.
| -1
|-
| '''briefing'''
| Data for the mission briefing (see below [[#Briefing Data|Briefing Data]]).
| -
|-
| '''markerName'''
| String ID that identifies this mission type on the Geoscape.
| STR_TERROR_SITE
|-
| '''markerIcon'''
| What icon should be used to represent this base/site (taken from GlobeMarkers section in extraSprites)
| -1
|-
| '''depth'''
| [''min'', ''max''] -- Defines the depth range to randomly choose from for this mission.
| [0, 0]
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).

'''Important''': mission duration should be at least 2 hours... if it's just 1 hour and it spawns at the whole hour, it also despawns at the same moment... and crashes the game!
| [0, 0]
|-
| '''music'''
| The list of musics this mission can choose from (if not specified, the music is taken from the terrain).
| -
|-
| '''points'''
| Negative score applied for each day this mission is active (applied daily for bases, or every half hour for mission sites)
| 0
|- style="background-color:#ddffdd;"
| '''unlockedResearch'''<br/>
'''unlockedResearchOnFailure'''<br/>'''unlockedResearchOnDespawn'''
| String ID of a research topic that will be granted for free (only on mission success).<br/>
String ID of a research topic that will be granted for free (only on mission failure).<br/>
String ID of a research topic that will be granted for free (only on mission site despawn).

Note: there will be no Ufopaedia article shown nor any other related effect; the research will just be silently added into the list of finished research projects.
| -
|- style="background-color:#ddffdd;"
| '''successEvents'''<br/>'''despawnEvents'''<br/>'''failureEvents'''
| Weighted lists of events that spawn instantly after a trigger (mission success, mission failure or mission site despawn).

More info: https://openxcom.org/forum/index.php/topic,10319.0.html
| -
|- style="background-color:#ddffdd;"
| '''counterSuccess'''<br/>'''counterFailure'''<br/>'''counterDespawn'''<br/>'''counterAll'''
'''decreaseCounterSuccess'''<br/>'''decreaseCounterFailure'''<br/>'''decreaseCounterDespawn'''<br/>'''decreaseCounterAll'''
| String IDs of custom counters for various battle outcomes. The counter values can be used in Arc/Mission/Event scripts (see '''missionMarkerName''').

More info: https://openxcom.org/forum/index.php/topic,10318.0.html
| -
|- style="background-color:#ddffdd;"
| '''missionBountyItem'''
| String ID of an item that will be added to base stores for free (only if the mission is finished successfully).

Note: the player will be informed in the Debriefing screen.
| -
|- style="background-color:#ddffdd;"
| '''missionBountyItemCount'''
| Defines how many '''missionBountyItem''' items should be added.
| 1
|- style="background-color:#ddffdd;"
| '''bughuntMinTurn'''
| Possibility to override global bug hunt minimum turn for this alien deployment only (usually to set a higher number for longer missions).
| 0 (no change)
|- style="background-color:#ddffdd;"
| '''noWeaponPile'''
| If enabled, unequipped craft items will not be available on the usual "weapon pile".
| false
|}

The following group of attributes is related only to alien bases (listed in a separate table just for convenience).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''alienBase'''
| Does this deployment correspond to an alien base assault? Used only in New Battle mode.
| false
|-
| '''genMission'''
| Which alien mission should this base generate?
Usually supply mission - can be used to generate any mission type except Mission Sites (UFO will be generated, but the site will never appear)
| -
|-
| '''genMissionFreq'''
| Daily chance for the base mission to be generated.
| 0
|- style="background-color:#ddffdd;"
| '''genMissionLimit'''
| Maximum number of times the '''genMission''' can be generated.
| 1000
|- style="background-color:#ddffdd;"
| '''genMissionRaceFromAlienBase'''
| True = use alien race from the alien base (vanilla behavior); False = use alien race from the mission's '''raceWeights''' (if not empty)

More info: https://openxcom.org/forum/index.php/topic,5717.msg143441.html#msg143441
| true
|- style="background-color:#ddffdd;"
| '''baseSelfDestructCode'''
| Discovering this research topic destroys all corresponding alien bases immediately.
| -
|- style="background-color:#ddffdd;"
| '''baseDetectionRange'''
| Radar detection range (in nautical miles) for an alien base. If more than 0, the base actively scans for xcom craft and generates xcom craft hunt missions.
| 0
|- style="background-color:#ddffdd;"
| '''baseDetectionChance'''
| Chance (0-100%) of the base radar detecting a craft that enters its range.
| 100
|- style="background-color:#ddffdd;"
| '''huntMissionMaxFrequency'''
| The maximum frequency (in minutes) of hunt missions generated by an alien base.
| 60
|- style="background-color:#ddffdd;"
| '''huntMissionRaceFromAlienBase'''
| True = use alien race from the alien base; False = use alien race from the mission's '''raceWeights''' (if not empty)
| true
|- style="background-color:#ddffdd;"
| '''huntMissionWeights'''
| A weighted list of hunt missions a base can generate, listed by "number of months passed".
| -
|- style="background-color:#ddffdd;"
| '''alienBaseUpgrades'''
| A weighted list of alien base upgrades, listed by "number of months passed".

More info: https://openxcom.org/forum/index.php/topic,6430.0.html
| -
|- style="background-color:#ddffdd;"
| '''resetAlienBaseAgeAfterUpgrade'''
| Defines whether the age of an alien base should be reset after an upgrade. Note: when upgrading from type A to type B, the flag is read from '''type A'''.
| false
|- style="background-color:#ddffdd;"
| '''resetAlienBaseAge'''
| Defines whether the age of an alien base should be reset after an upgrade. Note: when upgrading from type A to type B, the flag is read from '''type B'''.
| false
|- style="background-color:#ddffdd;"
| '''upgradeRace'''
| Defines the new race for an alien base after an upgrade (into this type). Note: when upgrading from type A to type B, the flag is read from '''type B'''.
| -
|- style="background-color:#ddffdd;"
| '''alienRaceEvolution'''
| Defines the alien race evolution rules.

More info: https://openxcom.org/forum/index.php?topic=12677.0
| -
|- style="background-color:#ddffdd;"
| '''fakeUnderwaterSpawnChance'''
| Chance (in percent) for the alien base to spawn on "fake underwater" globe texture.
| 0
|}

The following group of attributes is related to mission objectives (listed in a separate table just for convenience).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''allowObjectiveRecovery'''
| Can map objects of type defined by '''objectiveType''' be recovered or not?
| false
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -1
|-
| '''objectivesRequired'''
| How many of the tile types (defined in '''objectiveType''') must be destroyed in order for the mission to be considered a success.
| 0
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [-, 0]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [-, 0]
|- style="background-color:#ddffdd;"
| '''missionCompleteText'''
| Custom mission successful debriefing title.
| -
|- style="background-color:#ddffdd;"
| '''missionFailedText'''
| Custom mission failed debriefing title.
| -
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| 0
|- style="background-color:#ddffdd;"
| '''abortPenalty'''
| How many points the xcom will lose when this mission is aborted.
| 0
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (in vanilla it was after turn 20)

More info: https://openxcom.org/forum/index.php/topic,9051.0.html
| 20
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Possible values:
* 0 = Lose
* 1 = Abort
* 2 = Win
* <span style="background:#ddffdd;">3 = Win + all enemies surrender</span>
| 0
|-
| '''escapeType'''
| Which type of tiles can be used for escape. Possible values:
* 0 = None
* 1 = Exit tiles
* 2 = Entry tiles
* 3 = Either
| 0
|- style="background-color:#ddffdd;"
| '''vipSurvivalPercentage'''
| How many VIPs need to survive for the mission to be counted as successful.
| 0
|- style="background-color:#ddffdd;"
| '''markCiviliansAsVIP'''
| Should all civilians be marked as VIPs?

Besides this, you can use also the '''vip''' attribute on the unit level to have finer control over VIPs (and a possibility to mark also player-controlled summoned units as VIPs).
| false
|- style="background-color:#ddffdd;"
| '''keepCraftAfterFailedMission'''
| Defines whether the craft should be lost after a failed mission or not. Useful for example for timed missions where the craft doesn't wait for you (e.g. escape/extraction missions).
| false
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining. 
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** <span style="background:#ddffdd;">3 = forces a Win, same way as in option 2, but additionally all remaining enemies surrender.</span>
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units. 
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

==== Deployment Data ====

The following group of attributes is related to the ''"data:"'' section (used, for instance, in ''"alienDeployments:"'' or ''"reinforcements:"'').

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''alienRank'''
| [[Alien Rank|Rank]] associated with this deployment data, as defined by the order of the race in question (see above [[#Alien Races|Alien Races]])
| ''required''
|- style="background-color:#ddffdd;"
| '''customUnitType'''
| Allows to hardcode a unit to spawn, instead of taking the corresponding alien race member based on '''alienRank'''.
| -
|-
| '''lowQty'''
| Minimum quantity of aliens to spawn on beginner/experienced.
| ''required''
|-
| '''highQty'''
| Minimum quantity of aliens to spawn on superhuman. (minimum quantity for veteran/genius is the median of this and the previous value)
| ''required''
|- style="background-color:#ddffdd;"
| '''medQty'''
| Gives the ability to define more granular enemy numbers by difficulty. Defines quantity of aliens to spawn on veteran difficulty. Affects also experienced and genius difficulty.

More info: https://openxcom.org/forum/index.php/topic,10304.0.html
| 0
|-
| '''dQty'''
| Delta in Quantity, i.e. random number of aliens to spawn on top of the minimum (all difficulties).
| ''required''
|-
| '''extraQty'''
| Functionally identical to dQty, spawns a random number of additional aliens.
| 0
|-
| '''percentageOutsideUfo'''
| Percentage (0-100%) of aliens to spawn outside of the UFO (in UFO land/crash sites).

<div style="background:#ddffdd;">
Since OXCE 7.14, it can affect more deployments than just UFO landing/crash sites, see: '''forcePercentageOutsideUfo'''
</div>

<div style="background:#ddffdd;">
For '''reinforcements''', this attribute is reused/misused to specify whether to spawn enemies (use value 0) or civilians (use any other value than 0).
</div>
| ''required''
|-
| '''itemSets'''
| Three lists (one for each alien technology level) of [[#Items|items]] (string IDs) for the aliens to equip.
| ''required''
|- style="background-color:#ddffdd;"
| '''extraRandomItems'''
| One or more item lists with extra equipment. One item will be chosen from each list randomly.

More info: https://openxcom.org/forum/index.php/topic,7055.msg111746.html#msg111746
| -
|}

==== Briefing Data ====

The following group of attributes is related to the ''"briefing:"'' section (used, for instance, in ''"alienDeployments:"'' or ''"reinforcements:"'').

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text.  Larger values move the text further down the screen.
| 0
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''music'''
| The ID of the music to play.
| GMDEFEND
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
| '''background'''
| The background screen to show.
| BACK16.SCR
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|}

==== Reinforcements Script ====

<div style="background:#ddffdd;">The following group of attributes is related to the ''"reinforcements:"'' section (used, for instance, in ''"alienDeployments:"'').
Pay also attention to '''percentageOutsideUfo''' (see above [[#Deployment Data|Deployment Data]]).
</div>
{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| Name of a script item (reinforcements wave). Doesn't really do anything, it's used to organize your scripts and help debugging.
| ''required''
|- style="background-color:#ddffdd;"
| '''briefing'''
| Data for the reinforcements briefing (see above [[#Briefing Data|Briefing Data]]).
| -
|- style="background-color:#ddffdd;"
| '''minDifficulty'''
| Minimum difficulty on which this reinforcements wave will apply.
| 0
|- style="background-color:#ddffdd;"
| '''maxDifficulty'''
| Maximum difficulty on which this reinforcements wave will apply.
| 4
|- style="background-color:#ddffdd;"
| '''objectiveDestroyed'''
| Should this reinforcements wave only apply after mission objectives are destroyed?
| false
|- style="background-color:#ddffdd;"
| '''turns'''
| A list of turns on which this reinforcements wave should apply. Ignored if '''objectiveDestroyed''' is true.
Note: since OXCE v7.2, also turn 0 (zero) can be used. It spawns reinforcements before the first player turn (i.e. before the battle).
| -
|- style="background-color:#ddffdd;"
| '''minTurn'''
| Minimum turn on which this reinforcements wave should apply. Ignored if '''objectiveDestroyed''' is true or '''turns''' is not empty.
| 0
|- style="background-color:#ddffdd;"
| '''maxTurn'''
| Maximum turn on which this reinforcements wave should apply. Ignored if '''objectiveDestroyed''' is true or '''turns''' is not empty.
| -1
|- style="background-color:#ddffdd;"
| '''executionOdds'''
| Execution odds (in percent) for this reinforcements wave.
| 100
|- style="background-color:#ddffdd;"
| '''maxRuns'''
| How many times is this reinforcements wave allowed to be repeated.
| -1
|- style="background-color:#ddffdd;"
| '''useSpawnNodes'''
| Can map nodes be used to spawn reinforcements? Recommended value is true.
| true
|- style="background-color:#ddffdd;"
| '''mapBlockFilterType'''
| Which map blocks can be used to spawn reinforcements. Possible values:
* 0 = all blocks
* 1 = blocks marked in the map script
* 2 = blocks specified by '''spawnBlocks'''
* 3 = both union (blocks marked in the map script or specified by '''spawnBlocks''')
* 4 = both intersection (blocks marked in the map script AND specified by '''spawnBlocks''' at the same time)
| 3
|- style="background-color:#ddffdd;"
| '''spawnBlocks'''
| A list of codes specifying which blocks can be used for spawning. Empty = all. Possible values:
* EDGES = all map edges
* NORTH = north map edge
* WEST = west map edge
* SOUTH = south map edge
* EAST = east map edge
* NW = north-west map corner
* NE = north-east map corner
* SW = south-west map corner
* SE = south-east map corner
| -
|- style="background-color:#ddffdd;"
| '''spawnBlockGroups'''
| A list of block groups specifying which blocks can be used for spawning. Empty = all.
| -
|- style="background-color:#ddffdd;"
| '''spawnNodeRanks'''
| A list of node ranks specifying which map nodes can be used for spawning. Empty = all.
| -
|- style="background-color:#ddffdd;"
| '''spawnZLevels'''
| A list of Z-levels where units are allowed to spawn. Empty = all.
| -
|- style="background-color:#ddffdd;"
| '''randomizeZLevels'''
| Should the game try to spawn units on Z-levels in order specified by '''spawnZLevels''', or in random order? Doesn't apply to spawning on map nodes.
| true
|- style="background-color:#ddffdd;"
| '''minDistanceFromXcomUnits'''
| Used to spawn reinforcements away from any xcom units. Use with caution!
| 0
|- style="background-color:#ddffdd;"
| '''maxDistanceFromBorders'''
| Used to spawn reinforcements near the map borders. Allowed values are from 1 to 9 (tiles).
| 0
|- style="background-color:#ddffdd;"
| '''forceSpawnNearFriend'''
| If everything else fails, should the game spawn reinforcements next to a random existing unit of the same faction?
| true
|- style="background-color:#ddffdd;"
| '''data'''
| List of deployment data for each alien rank in this reinforcements wave (see above [[#Deployment Data|Deployment Data]]).
| -
|}

=== Battle Starting Conditions ===

<div style="background:#ddffdd;">Defines various pre-conditions and limitations applied before a certain Battlescape mission, listed in ''"startingConditions:"''.

Starting conditions can be defined on alien deployments only (not on terrains):
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the starting condition.
| ''required''
|- style="background-color:#ddffdd;"
| '''defaultArmor'''
| If a soldier's armor is not permitted on a mission (see '''allowedArmors''' and '''forbiddenArmors''' below), it will be replaced by a default armor. Default armor is defined for each soldier type separately as a weighted list of possible armor replacements. There is also a special armor ID "noChange" representing no change needed (i.e. giving you a chance to keep the original armor even if it is not allowed... don't ask me why, ask modders!)
| -
|- style="background-color:#ddffdd;"
| '''allowedArmors''' '''forbiddenArmors'''
| A list of allowed/forbidden armors for a mission. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''forbiddenArmorsInNextStage'''
| A list of forbidden armors for a mission (in second stage).

More info: https://openxcom.org/forum/index.php/topic,10194.msg149818.html#msg149818
| -
|- style="background-color:#ddffdd;"
| '''allowedVehicles''' '''forbiddenVehicles'''
| A list of allowed/forbidden vehicles (HWP/SWS) for a mission. Not permitted vehicles will stay at the base. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''allowedItems''' '''forbiddenItems'''
| A list of allowed/forbidden items (weapons, equipment, etc.) for a mission. Not permitted items will stay at the base. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''allowedItemCategories''' '''forbiddenItemCategories'''
| A list of allowed/forbidden item categories (categories are freely definable by modders) for a mission. This is used to simplify/shorten the definition of allowed/forbidden items. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''allowedCraft''' '''forbiddenCraft'''
| A list of allowed/forbidden craft for a mission. Not permitted craft cannot target the mission destination at all. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''allowedSoldierTypes''' '''forbiddenSoldierTypes'''
| A list of allowed/forbidden soldier types for a mission. If there are any not permitted soldier types onboard a craft, it won't be able to target the mission destination at all. Only one of these two attributes can be used.
| -
|- style="background-color:#ddffdd;"
| '''requiredItems'''
| A list of items (and their quantities) required for a mission (e.g. a skeleton key from EU2012).
| -
|- style="background-color:#ddffdd;"
| '''craftTransformations'''
| A list of craft transformations (oldCraft: newCraft).

More info: https://openxcom.org/forum/index.php/topic,4444.msg148706.html#msg148706
| -
|- style="background-color:#ddffdd;"
| '''destroyRequiredItems'''
| Defines whether required items should be destroyed or not (when craft landing is confirmed).
| false
|- style="background-color:#ddffdd;"
| '''requireCommanderOnboard'''
| Defines whether a commander must be present onboard for this mission.
| false
|}

=== Battle Enviro Effects ===

<div style="background:#ddffdd;">Defines various effects applied during a certain Battlescape mission, listed in ''"enviroEffects:"''.

Enviro effects can be defined on alien deployments and on terrains. If both are defined, deployment's enviro effects will be used.
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the enviro effects.
| ''required''
|- style="background-color:#ddffdd;"
| '''paletteTransformations'''
| A list of palette transformations (oldPaletteName: newPaletteName) to apply during the mission (or mission stage). New palettes should be similar to original palettes, they should only convey visual effects like pollution, underwater environment, etc. For UFO-based mods only one palette (PAL_BATTLESCAPE) needs to be changed, for TFTD-based mods up to 4 palettes (for each depth).
| -
|- style="background-color:#ddffdd;"
| '''environmentalConditions'''
| A set of [[#Environmental Conditions|environmental conditions]] (one for each faction: STR_FRIENDLY, STR_HOSTILE or STR_NEUTRAL), see below. Environmental conditions define a special effect applied to each unit of a given faction at the beginning of their turn. This can be for example damage in toxic environment, stun in harsh environment, morale decrease in tough battles, etc.

Note: the player is informed about the effects applied on the [Next Turn] screen.
| -
|- style="background-color:#ddffdd;"
| '''armorTransformations'''
| A list of armor transformations (oldArmorName: newArmorName) to apply during the mission (or mission stage). This can be only visual (e.g. replace helmetless armors with armors with a helmet when going underwater or in space) or also functional (effectively changing unit's stats and armor properties). The change is only temporary and reverted to original armor when the mission ends.

Note: if the armor is transformed, it is not checked if it is allowed or not and it is not replaced with default armor either.
| -
|- style="background-color:#ddffdd;"
| '''mapBackgroundColor'''
| Possibility to change the color of the background outside of the map boundaries. Used for example to visually indicate the type of environment.
| 15
|- style="background-color:#ddffdd;"
| '''ignoreAutoNightVisionUserSetting'''
| Allows the modder to turn off the automatic night vision user option for this particular environment.
| false
|- style="background-color:#ddffdd;"
| '''inventoryShockIndicator'''
| String ID of the shock indicator sprite (in the inventory). Used to override the global one, for example in normal environment it can indicate body shock, in underwater environment drowning and in space suffocating.
| -
|- style="background-color:#ddffdd;"
| '''mapShockIndicator'''
| String ID of the shock indicator sprite (on the map). Used to override the global one.
| -
|}

==== Environmental Conditions ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''globalChance'''
| Chance (0-100%) that this environmental condition will be turned on. Dice roll is performed only once, when the battle starts.
| 100
|- style="background-color:#ddffdd;"
| '''chancePerTurn'''
| Chance (0-100%) that a unit will be affected. Dice roll is performed each turn, for each unit separately.
| 0
|- style="background-color:#ddffdd;"
| '''firstTurn'''
| When should the environmental condition start affecting the units. XCOM units cannot be affected before their first turn (aliens and civilians can).
| 1
|- style="background-color:#ddffdd;"
| '''lastTurn'''
| When should the environmental condition stop affecting the units.
| 1000
|- style="background-color:#ddffdd;"
| '''message'''
| String ID of the message displayed on the [Next Turn] screen, explaining to the player what is happening.
| -
|- style="background-color:#ddffdd;"
| '''color'''
| Color (0-255) of the above message.
| 29
|- style="background-color:#ddffdd;"
| '''weaponOrAmmo'''
| The item (a weapon or ammo) that defines the actual effect. Compared to normal weapons, there are some limitations. See notes below.
| -
|- style="background-color:#ddffdd;"
| '''side'''
| The unit side where the effect is applied. Possible options:
* -1 = random,
* 0 = front
* 1 = left
* 2 = right
* 3 = rear
* 4 = under
| -1
|- style="background-color:#ddffdd;"
| '''bodyPart'''
| The unit body part where the effect is applied. Possible options:
* -1 = random
* 0 = head
* 1 = torso
* 2 = right arm
* 3 = left arm
* 4 = right leg
* 5 = left leg
| -1
|}

<div style="background:#ddffdd;">
Note: there are limitations to what the effect can do, since we're not using a projectile and nobody is actually shooting
* no power bonus based on shooting unit's stats (nobody is shooting, duh!)
* no power range reduction (there is no projectile, range = 0)
* no AOE damage from explosions (targets are damaged directly without affecting anyone/anything else)
* no terrain damage
* no self-destruct
* no vanilla target morale loss when hurt; vanilla morale loss for fatal wounds still applies though
* no setting target on fire (...could be added/implemented if needed)
* no fire extinguisher
</div>

=== Custom Palettes ===

<div style="background:#ddffdd;">Defines custom 8bit palettes, listed in ''"customPalettes:"''.

These palettes can:
* either '''globally''' override the default game palettes
* or serve as additional palettes used only in certain situations (see '''paletteTransformations''')
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| String ID of the custom palette.
| ''required''
|- style="background-color:#ddffdd;"
| '''target'''
| String ID of the target palette:
* for global palette replacement, use one of the game's default palette names:
** '''UFO''': BACKPALS.DAT, PAL_BASESCAPE, PAL_BATTLEPEDIA, PAL_BATTLESCAPE, PAL_GEOSCAPE, PAL_GRAPHS and PAL_UFOPAEDIA
** '''TFTD''': BACKPALS.DAT, PAL_BASESCAPE, PAL_BATTLESCAPE, PAL_BATTLESCAPE_1, PAL_BATTLESCAPE_2, PAL_BATTLESCAPE_3, PAL_GEOSCAPE and PAL_GRAPHS
* for additional palettes, just use the same name as for '''type'''
| -
|- style="background-color:#ddffdd;"
| '''file'''
| Path to a file containing the palette definition, in JASC format.
| -
|- style="background-color:#ddffdd;"
| '''palette'''
| Alternative to '''file'''. You can specify the palette directly in the ruleset using a list of RGB values. Using this method, you don't have to specify all 256 colors; you can also use it to just change a few colors and leave the rest unchanged.
| -
|}

=== Research ===

Defines a [[Research|research topic]] that X-COM scientists can investigate, listed in ''"research:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''name'''
| String ID of the research project's name.
| ''required''
|-
| '''lookup'''
| String ID of the research project's display result (used when multiple projects give the same result, e.g. researching Sectoid Engineer and Sectoid Navigator both give the same live Sectoid info in the Ufopaedia).

'''Warning''': DON'T use the same '''lookup''' as '''name'''! Leave '''lookup''' empty/undefined in such case.
| -
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed.
| -
|- style="background-color:#ddffdd;"
| '''spawnedItem'''
| Item to be added to base stores, when the research is completed.

Tip: allows you to create unique items in limited quantities (e.g. special weapons, keys to special missions, etc.). Don't forget to inform the player in the pedia article!
| -
|- style="background-color:#ddffdd;"
| '''spawnedItemCount'''
| Defines how many '''spawnedItem''' items should be added.
| 1
|- style="background-color:#ddffdd;"
| '''spawnedItemList'''
| A list of items to be added to base stores, when the research is completed.
| -
|- style="background-color:#ddffdd;"
| '''spawnedEvent'''
| Geoscape event to be scheduled, when the research is completed.
| -
|-
| '''cost'''
| Number of man-days (on average, the final time will be 50-150% this value) required to complete this project.
| 0
|-
| '''points'''
| [[Score]] earned for completing this project.
| 0
|-
| '''dependencies'''
| List of research projects that can unlock access to this one. If the full list is researched, or if one of the projects on the list "unlocks" this one, it becomes available.
| -
|-
| '''unlocks'''
| List of research projects unlocked, regardless of other dependencies, but not requirements, by completing this project (for example, any live alien unlocks "Alien Origins").
| -
|- style="background-color:#ddffdd;"
| '''disables'''
| A list of research projects disabled by completing this project.

Notes:
* this is one of the ways how to branch your "story", e.g. create alternative endings
* it can also be used to hide obsolete stuff in the market, workshop, pedia, etc.
* disabled topics can be re-enabled using '''reenables'''
| -
|- style="background-color:#ddffdd;"
| '''reenables'''
| A list of research projects re-enabled by completing this project.
| -
|-
| '''getOneFree'''
| List of "bonus" research projects that may be granted when completing this project. Examples: alien navigators (give random alien mission info), medics (give random alien interrogation or autopsy), engineers (give random UFO type info).

'''getOneFree''' only works when the research project is completed in a Laboratory. All other means of obtaining a research topic ignore '''getOneFree'''.
| -
|- style="background-color:#ddffdd;"
| '''getOneFreeProtected'''
| A list of additional "bonus" research projects that may be granted when completing this project. Each topic in the list is "protected" by another topic, which allows you finer control over when the player gets the bonus.

For example: you could divide the topics into early-game, mid-game and late-game and protect each group by some "gateway topic".

'''getOneFreeProtected''' only works when the research project is completed in a Laboratory. All other means of obtaining a research topic ignore '''getOneFreeProtected'''.
| -
|- style="background-color:#ddffdd;"
| '''sequentialGetOneFree'''
| Should the topics from '''getOneFree''' and '''getOneFreeProtected''' be given randomly (false) or sequentially (true).
| false
|-
| '''requires'''
| List of research projects absolutely required before this project can be unlocked. For example, "The Martian Solution" will not even be considered for unlocking until AFTER "Alien Origins" is completed.
| -
|- style="background-color:#ddffdd;"
| '''requiresBaseFunc'''
| A list of services (for a given base) required to start this project.
| -
|-
| '''needItem'''
| Does this project require an [[#Items|item]] of the same name?
| false
|-
| '''destroyItem'''
| Will this item be destroyed (removed from stores) after research is finished?
| false
|- style="background-color:#ddffdd;"
| '''neededItem'''
| Allows to override the needed item (i.e. if it's different than the name of the research project).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|- style="background-color:#ddffdd;"
| '''repeatable'''
| Is this research repeatable, i.e. never marked as discovered? See https://openxcom.org/forum/index.php?topic=12339.0
| false
|- style="background-color:#ddffdd;"
| '''increaseCounter'''
| A list of object counters to increase when the project is completed.
| -
|- style="background-color:#ddffdd;"
| '''decreaseCounter'''
| A list of object counters to decrease when the project is completed.
| -
|}

=== Manufacture ===

Defines a [[Manufacture|manufacture project]] that X-COM engineers can produce, listed in ''"manufacture:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''name'''
| String ID of the manufacturing project's name.
| ''required''
|-
| '''category'''
| String ID of the manufacturing project's category.
Important: craft manufacturing projects MUST be defined in the STR_CRAFT category.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this project. If none are specified, this project is unlocked from the start.
| -
|- style="background-color:#ddffdd;"
| '''requiresBaseFunc'''
| A list of services required (in the given base) to be able to start this project.
| -
|-
| '''space'''
| Amount of [[Workshop]] space required to begin this project.
| 0
|-
| '''time'''
| Number of man-hours required per production.
| 0
|- style="background-color:#ddffdd;"
| '''transferTimes'''
| Provides ability to define/override transfer times for produced items/craft and/or manufacture-hired people.

More info: https://openxcom.org/forum/index.php?topic=11992.0
| -
|-
| '''cost'''
| Monetary deduction per production.
| 0
|- style="background-color:#ddffdd;"
| '''points'''
| [[Score]] earned/lost for completing every production item.
| 0
|- style="background-color:#ddffdd;"
| '''refund'''
| Whether the resources needed for a project should be refunded when a project is cancelled before completion.

Notes:
* if enabled, the ''STOP PRODUCTION'' button is replaced by a ''REFUND'' button
* in case you didn't know: in vanilla, when you started a manufacture project (even with 0 engineers allocated and no time passed yet), all the resources were irrevocably gone
| false
|-
| '''requiredItems'''
| List of [[#Items|items]] required and consumed per production.
| -
|-
| '''producedItems'''
| List of [[#Items|items]] manufactured per production. If not specified, defaults to 1 item with the same string ID as the manufacture project.

Note: It's possible to add only one craft per list.
| '''name''': 1
|- style="background-color:#ddffdd;"
| '''randomProducedItems'''
| List of item sets with weights. One item set is chosen randomly for production.

More info: https://openxcom.org/forum/index.php/topic,6867.msg109423.html#msg109423
| -
|- style="background-color:#ddffdd;"
| '''spawnedPersonType'''
| Allows to "manufacture" soldiers, scientists and engineers. More info here: https://openxcom.org/forum/index.php/topic,4187.msg78212.html#msg78212

Note: you can't use existing soldiers as "input" here, only items or prisoners. For transformation of existing soldiers (e.g. from normal humans to MECs), please use the [[#Soldier Transformation|Soldier Transformation]] functionality and ruleset.
| -
|- style="background-color:#ddffdd;"
| '''spawnedPersonName'''
| When "manufacturing" a soldier, you can (optionally) specify also his/her name. The name is translatable.
| -
|- style="background-color:#ddffdd;"
| '''spawnedSoldier'''
| When "manufacturing" a soldier, you can (optionally) specify overrides for any of the soldier's attributes. Uses the same syntax as the saved games. Cannot override soldier's ID and name.

More info: https://openxcom.org/forum/index.php/topic,8615.msg132649.html#msg132649
| -
|}

==== Manufacture Shortcuts ====

<div style="background:#ddffdd;">Copies an existing manufacture project and allows break down of certain components into simpler components, listed in ''"manufactureShortcut:"''.</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''name'''
| String ID of the new manufacturing project's name.
| ''required''
|- style="background-color:#ddffdd;"
| '''startFrom'''
| String ID of the manufacturing project to copy.
| ''required''
|- style="background-color:#ddffdd;"
| '''breakDownItems'''
| List of manufacture projects (string IDs) to break down. Break down is recursive (i.e. repeats until there is nothing more to break down).
| -
|- style="background-color:#ddffdd;"
| '''breakDownRequires'''
| Whether the research requirements should be broken down or not.
| false
|- style="background-color:#ddffdd;"
| '''breakDownRequiresBaseFunc'''
| Whether the base services requirements should be broken down or not.
| true
|}

=== UFOpaedia Article ===

Defines an article in the in-game [[UFOpaedia]], listed in ''"ufopaedia:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| String ID of the article name. This must match the ID of the object associated with this article, if applicable.
| ''required''
|-
| '''title'''
| String ID of the article title. If omitted, the '''id''' is used.
| -
|-
| '''type_id'''
| Type of this article:
* 1 = [[Craft]]
* 2 = [[Craft Armaments]]
* 3 = [[HWP]]
* 4 = [[Equipment (EU)|Equipment]]
* 5 = [[Armour]]
* 6 = [[Base Facilities]]
* 7 = Text & Image (eg. [[Alien Life Forms]], [[UFO Components]])
* 8 = Text (eg. [[Alien Research]])
* 9 = [[UFO]]
* 10 = [[TFTD]]
* 11 = TFTD [[Subs]]
* 12 = TFTD [[Sub Armaments]]
* 13 = TFTD [[Submersible Weapons Systems]]
* 14 = TFTD [[Equipment (TFTD)|Equipment]]
* 15 = TFTD [[Armour (TFTD)|Armour]]
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 17 = TFTD [[Alien Subs]]
* <span style="background:#ddffdd;">18 = Player Units (Soldiers), OXCE only: https://openxcom.org/forum/index.php?msg=174672</span>
* <span style="background:#ddffdd;">19 = AI Units (Aliens/Civilians) and Player Units (HWPs and Summons), OXCE only: https://openxcom.org/forum/index.php?msg=174746</span>

<span style="background:#ddffdd;">In OXCE, the TFTD-style articles can also be used in UFO-based mods.</span>
| ''required''
|-
| '''section'''
| String ID of the UFOpaedia section this article belongs to.
| -
|- style="background-color:#ddffdd;"
| '''hiddenCommendation'''
| If set on a Commendation article (determined by '''section'''), the article will remain hidden until the corresponding commendation is awarded to at least one soldier.
| false
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this article. If none are specified, this article is unlocked from the start.
<span style="background:#ddffdd;">If using lootable weapons ('alien' weapons that can be used without research) needing a research to fully unlock, make sure to define it on both the weapon and ammo.
Otherwise the damage reading is visible on the inventory screen using [ALT] on a clip. </span>
| -
|- style="background-color:#ddffdd;"
| '''disabledBy'''
| List of [[#Research|topics]] (string IDs) that must be researched to disable this article. If none are specified, this article is never disabled.
| -
|-
| '''image_id'''
| Filename of the [[UP001.SPK-UP042.SPK|background image]] displayed on this article, if applicable.

<div style="background:#ddffdd;">
In OXCE:
* This attribute can be used also for ''Vehicle'' articles
* If the name contains a '''"_CPAL" suffix''', its (custom) palette will be used instead of the default one. Relevant for ''Soldier types, Unit types, Craft, CraftWeapon, TextImage and Vehicle (HWP)'' articles. More info here: https://openxcom.org/forum/index.php/topic,4957.0.html</div>
| -
|-
| '''text'''
| String ID of the description displayed on this article.

<span style="background:#ddffdd;">In OXCE, you can use the {ALT} keyword to switch between primary and secondary color.</span>
| -
|- style="background-color:#ddffdd;"
| '''align_bottom'''
| If set to true, the '''text''' will be vertically aligned to the bottom.
| false
|-
| '''text_width'''
| Maximum width of the text displayed, only applicable to ''TextImage'' articles.
| EU (0), TFTD (157)
|-
| '''rect_stats'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the stats text on the screen, only applicable to ''Craft'' articles.

<span style="background:#ddffdd;">In OXCE, it is also applicable to ''Soldier types'' and ''Unit types'' articles.</span>

Example:

 - id: STR_SKYRANGER
   rect_stats:
     x: 7
     y: 42
     width: 307
     height: 125
| -
|- style="background-color:#ddffdd;"
| '''rect_armor'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the armor stats text on the screen, only applicable to ''Unit types'' articles.

More info: https://openxcom.org/forum/index.php?msg=174746

Example:

 - id: STR_SECTOID_COMMANDER
   rect_armor:
     x: 180
     y: 48
     width: 130   # 90+20+20 (don't forget there are other translations than just EN and RU)
     height: 40   # 5 rows
| -
|-
| '''rect_text'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the description text on the screen, only applicable to ''Craft'' articles. Defined in the same way as "rect_stats".

<span style="background:#ddffdd;">In OXCE, it is also applicable to ''TextImage'', ''Soldier types'' and ''Unit types'' articles.</span>
| -
|-
| '''weapon'''
| String ID of the weapon, only applicable to ''Vehicle'' (HWP/SWS) articles.

<div style="background:#ddffdd;">
In OXCE:
* This attribute can be used also for ''Equipment'' articles</div>
| -

|- style="background-color:#ddffdd;"
| '''psi_skill_mode'''
| How to display the psi skill stat for ''Soldier types'' articles.
* 0 = not shown (default)
* 1 = shown processed
* 2 = shown raw

More info: https://openxcom.org/forum/index.php?msg=174672
| 0
|- style="background-color:#ddffdd;"
| '''unit_mode'''
| How to display unit and armor stats for ''Unit types'' articles.
* 0 = as hostile with difficulty label (default)
* 1 = as neutral/allied
* 2 = show both: first as 1, then as 0

More info: https://openxcom.org/forum/index.php?msg=174746
| 0

|- style="background-color:#ddffdd;"
| '''pages'''
| Configuration of additional pages for an article.
* Each page can have its own title and text description.
* Additionally, you can define which '''ammoSlot''' will be used to limit the display of supported attack types and compatible ammo.
* If multiple pages have same value of '''ammoSlot''', then each page will show successive group of 3 ammo items available for this slot.

Example:

  - id: STR_PISTOL
    pages:
      - title: STR_PISTOL
        text: STR_PISTOL_UFOPEDIA
        ammoSlot: 0                  # default for all pages
      - title: STR_PISTOL
        text: STR_PISTOL_UFOPEDIA_2
        ammoSlot: 1                  # ammo and attack types relevant for the second ammo slot (0 = first slot)
      - title: STR_PISTOL_UFOPEDIA_TITLE_3
        text: STR_PISTOL_UFOPEDIA_3
        
| Only one page using standard '''title''' and '''text'''.
|}

=== UFO Trajectories ===

Defines a trajectory carried out by an UFO during an [[#Alien Missions|alien mission]], listed in ''"ufoTrajectories:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| String ID of the trajectory name.
| ''required''
|-
| '''groundTimer'''
| Amount of seconds for the UFO to spend on Ground waypoints.
| 5
|-
| '''waypoints'''
| List of items defining the waypoints and flight segments for the UFO to traverse, defined as ''[zone, altitude, speed]''.<br>
'''zone''': Regional missionZone index (used to randomly generate the waypoint's coordinates).<br>
'''altitude''': UFO altitude:
* 0 - Ground
* 1 - Very Low
* 2 - Low
* 3 - High
* 4 - Very High
'''speed''': UFO speed as a percentage (0-100%) of its maximum speed.
| -
|}

Each trajectory has X flight segments and X+1 waypoints... please pause reading here and think for a while why that is the case.

The best explanation how the flight segments and waypoints are encoded in the ruleset is done via an example:

  waypoints:
    - [A, B, C]
    - [D, E, F]
    - [G, H, I]
    - [J, K, L]
    - [M, N, P]

This example can be interpreted as:
# go from zone A to zone D at altitude B and speed C
# go from zone '''D to zone D''' at altitude E and speed F
# go from zone D to zone G at altitude H and speed I
# go from zone G to zone J at altitude K and speed L
# go from zone J to zone M at altitude N and speed P

This example contains 5 flight segments (AD, DD, DG, GJ and JM) and 6 waypoints (A, D, D, G, J and M).

Please note especially the second line, where zone D is targeted AGAIN, this happens automatically/internally and always on the second line.

Also, if any altitude (B, E, H, K or N) would be zero (0 = Ground), the UFO would first wait landed in the start zone for some time before taking off to the destination zone (at altitude 1 = Very Low).

=== Alien Missions ===

Defines an [[Alien Missions|alien mission]] carried out by UFOs on the Geoscape, listed in ''"alienMissions:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the mission type.
| ''required''
|-
| '''points'''
| [[Score]] allocated to aliens for successfully completing this mission.
| 0
|-
| '''waves'''
| List of UFO waves to spawn as this mission progresses, as described below.
| ''required''
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
* <span style="background:#ddffdd;">6 = instant xcom base defense:</span> https://openxcom.org/forum/index.php/topic,10808.0.html
| 0
|- style="background-color:#ddffdd;"
| '''showAlienBase'''
| Should a new alien base be discovered/shown immediately after it is spawned? (works for '''objective''' 1 and 2)
| false
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''spawnZone'''
| Regional missionZone to use when spawning mission sites / alien bases.
| -1
|-
| '''missionWeights'''
| Only works for alien retaliation missions spawned during dogfights. If your mod has multiple possible retaliation missions, the game chooses one randomly, but considering weights defined in this attribute. The weights are defined as a list of (month: weight) pairs. If nothing is specified, weight is 1 (for all months).
| -
|-
| '''retaliationOdds'''
| Probability (0-100%) that a UFO shot down while performing this mission will generate a Retaliation mission.
| -1
|- style="background-color:#ddffdd;"
| '''endlessInfiltration'''
| Should an infiltration mission end after the first cycle (false) or continue indefinitely (true)?
| true
|- style="background-color:#ddffdd;"
| '''skipScoutingPhase'''
| Mark all xcom bases in the mission region as retaliation targets automatically at the mission start? (and also before each UFO is spawned, if the modder decides to spawn more UFOs)
| false
|- style="background-color:#ddffdd;"
| '''multiUfoRetaliation'''
| Keep generating UFOs until the first base defense?
| false
|- style="background-color:#ddffdd;"
| '''multiUfoRetaliationExtra'''
| Keep generating UFOs until the end of the alien mission?
| false
|- style="background-color:#ddffdd;"
| '''ignoreBaseDefenses'''
| Should the attacking retaliation UFO ignore xcom base defenses?
| false
|- style="background-color:#ddffdd;"
| '''instaHyper'''
| Display hyper-wave decoder info at base defense even if the UFO was not detected yet? https://openxcom.org/forum/index.php?topic=12524.msg172045#msg172045
| false
|- style="background-color:#ddffdd;"
| '''despawnEvenIfTargeted'''
| Should a mission site expire/despawn even if it is targeted by an xcom craft or not?
| false
|- style="background-color:#ddffdd;"
| '''respawnUfoAfterSiteDespawn'''
| Should the original UFO re-spawn when the mission site it spawned de-spawns?

More info: https://openxcom.org/forum/index.php?topic=11923.0
| false
|- style="background-color:#ddffdd;"
| '''interruptResearch'''
| Discovering this research topic interrupts the mission immediately.
| -
|-
| '''siteType'''
| Alien deployment to use when spawning mission sites / alien bases. If not specified, alienDeployment from Geoscape texture is used.

Note: for alien bases there is one more hardcoded fallback (STR_ALIEN_BASE_ASSAULT) if both deployments mentioned above are missing.
| -
|-
| '''raceWeights'''
| List of alien races to carry out this mission, and their weights (i.e. not percentages) of how likely they will be selected for this mission, listed by "number of months after game beginning".
Note: If multiple rulesets define the same mission raceWeights, then they'll be merged, not replaced (so if you're making a new race mod, you only need to specify their weights). Weights for new races will be added to the list, while weights for existing races will replace old ones. The only way to "remove" old races is to explicitly set them to 0.
| ''required''
|- style="background-color:#ddffdd;"
| '''operationType'''
| From where does this mission operate?

Possible options:
* 0 = from space
* 1 = from an existing alien base in the mission region
* 2 = from a new alien base in the mission region
* 3 = from a new alien base in the mission region if necessary, otherwise from an existing alien base
* 4 = from an existing alien base anywhere on Earth
* 5 = from a new alien base anywhere on Earth if necessary, otherwise from an existing alien base
* 6 = a hunt mission spawned from an existing alien base

More description for this and the following attributes here: https://openxcom.org/forum/index.php/topic,6557.msg104669.html#msg104669
| 0
|- style="background-color:#ddffdd;"
| '''operationSpawnZone'''
| The missionZone for spawning the operation base (if necessary), see above.
| -1
|- style="background-color:#ddffdd;"
| '''operationBaseType'''
| The type of operation base to spawn (references alien deployment), see above.
| -
|- style="background-color:#ddffdd;"
| '''targetBaseOdds'''
| The odds of this mission targeting an xcom base. Works only for '''genMission''' spawned by an alien base.
| 0
|- style="background-color:#ddffdd;"
| '''regionWeights'''
| The region distribution over game time. Works only for '''genMission''' spawned by an alien base.
| -
|}

==== Waves ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''ufo'''
| String ID of the [[#UFOs|UFO]] to spawn.
| ''required''
|-
| '''count'''
| Number of UFOs to spawn.
| 0
|-
| '''trajectory'''
| String ID of the [[#UFO Trajectories|trajectory]] for this UFO to use when entering Earth's atmosphere.
| ''required''
|-
| '''timer'''
| How long after the previous wave should this wave arrive? (in minutes)

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 400) + 48)) minutes, or between 1.0 and 9.3 days
* The timer on the first (or the only) wave will be overwritten with the '''startDelay''' value from the mission script if the latter is not equal 0
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| false
|- style="background-color:#ddffdd;"
| '''objectiveOnTheLandingSite'''
| Only relevant when using non-point mission zone areas for mission site spawning.

More info: https://openxcom.org/forum/index.php/topic,10305.0.html

Since OXCE v7.9 also relevant for alien base building: https://openxcom.org/forum/index.php/topic,10860.0.html
| false
|- style="background-color:#ddffdd;"
| '''objectiveOnXcomBase'''
| Overrides the mission site location with an xcom base location.

More info: https://openxcom.org/forum/index.php/topic,10810.0.html
| false
|- style="background-color:#ddffdd;"
| '''hunterKillerPercentage'''
| The chance (0-100%) to become a hunter-killer UFO upon spawning.

Possible options:
* -1 = take the info from RuleUfo
*  0 = not a hunter-killer
*  1-99 = percentage chance to be flagged as hunter-killer upon spawn
*  100 = always a hunter-killer
| -1
|- style="background-color:#ddffdd;"
| '''huntMode'''
| Algorithm to use when prioritizing xcom targets.

Possible options:
* -1 = take the info from RuleUfo
* 0 = prefer hunting xcom interceptors
* 1 = prefer hunting xcom transports
* 2 = random preference (0 or 1) determined at spawn
| -1
|- style="background-color:#ddffdd;"
| '''huntBehavior'''
| Algorithm to use when considering retreating from the dogfight.

Possible options:
* -1 = take the info from RuleUfo
* 0 = flee if you're losing
* 1 = never flee, never crash (is destroyed instead of crashing)
* 2 = random preference (0 or 1) determined at spawn
| -1
|- style="background-color:#ddffdd;"
| '''escort'''
| Does this wave escort/protect the previous wave(s)?
| false
|- style="background-color:#ddffdd;"
| '''interruptPercentage'''
| The chance (0-100%) to interrupt the alien mission when successfully shooting down a UFO from this wave; or when winning a ground mission of a landed UFO.

Possible options:
*  0 = cannot interrupt
*  1-99 = percentage chance to be interrupted
*  100 = always interrupted
| 0
|}

=== Mission Scripts ===

MissionScripts determines how many missions are spawned each month.

<div style="background:#ddffdd;">
Standard monthly mission scripts are defined under ''"missionScripts:"''.

In OXCE, there are also adhoc mission scripts triggered by events any time during the month, those are defined under ''"adhocScripts:"''.

More info: https://openxcom.org/forum/index.php?topic=12338.msg171478#msg171478
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Name of the script used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''label'''
| A numeric label that can be used for conditional execution of commands. Each label should be unique within the command list (0=default no need for uniqueness).
| 0
|-
| '''conditionals'''
| Defines the conditions that allows the execution of this command. For example, [1, -4] means it will be executed if command with '''label''' 1 was a success and command with '''label 4''' failed.

Commands that are not yet executed are always in failed state.
| -
|- style="background-color:#ddffdd;"
| '''adhocMissionScriptTags'''
| Tags the adhoc mission script commands. So that geoscape events can execute only certain tagged commands.

Only relevant for '''adhocScripts''', not relevant for '''missionScripts'''.

More info: https://openxcom.org/forum/index.php?topic=12338.msg171478#msg171478
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the alien strategy mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (i.e. terror sites) with regular missions. They are generated too differently. Using '''executionOdds''' and '''conditionals''' instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base... instead of a random region (which CAN also contain an xcom base).
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|- style="background-color:#ddffdd;"
| '''randomDelay'''
| Additional randomized delay (in minutes). Total delay = '''startDelay''' + RNG(0, '''randomDelay''')
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base. 
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|- style="background-color:#ddffdd;"
| '''maxDifficulty'''
| This command only applies to difficulty levels of this or below.
| 4
|- style="background-color:#ddffdd;"
| '''minScore'''
| This command only applies if last month's rating was above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxScore'''
| This command only applies if last month's rating was below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''minFunds'''
| This command only applies if the new month's funds are above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxFunds'''
| This command only applies if the new month's funds are below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''missionVarName'''<br/>'''missionMarkerName'''
| These variables allow accessing internal mission script tracking variables (see '''varName'''), or internal object counters.

More info: https://openxcom.org/forum/index.php/topic,10318.0.html
| -
|- style="background-color:#ddffdd;"
| '''counterMin'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at least this number.
| 0
|- style="background-color:#ddffdd;"
| '''counterMax'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at most this number. -1 denotes no limit
| -1
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example 
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the Ultimate Threat. 
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched T'Leth.
Several research triggers can be combined and for the mission to appear all must be fulfilled. 
| -
|- style="background-color:#ddffdd;"
| '''itemTriggers'''
| A list of items that can influence the execution of this script. Similar to research triggers; checks the presence of items in the base stores (not anywhere else).
| -
|- style="background-color:#ddffdd;"
| '''facilityTriggers'''
| A list of base facilities that can influence the execution of this script. Similar to research triggers; checks the presence of a facility (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''soldierTypeTriggers'''
| A list of soldier types that can influence the execution of this script. Similar to research triggers; checks the presence of a soldier type (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''pactCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks if the country has (or hasn't) signed a pact with aliens.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInRegionTriggers'''
| A list of regions that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given region.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given country.
| -
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking '''maxRuns''' and '''avoidRepeats'''.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there.

Note: this is used for "classic approach" (before mission scripts existed), where missions were pre-generated at the beginning of the campaign in alien strategy table and removed from there one by one to avoid repetitions.
| true
|}

==== Guidelines/Tips ====

Relevant ruleset files for editing alien missions of "mission site" type (e.g. terror sites):

* '''missionScripts.rul''' - this is where alienMissions are generated
* '''alienMissions.rul''' - alienMissions provide a link to the region (unless overridden by missionScript); and define missionWaves, which ultimately provide links to UFO trajectories
* '''ufoTrajectories.rul''' - provides a link to regional missionZones (= places where the the UFOs start/end, change direction, land, and potentially create mission sites)
** Note: mission sites can also be spawned without actual UFOs if so desired (e.g. TFTD artifact sites/shipping lanes)
* '''regions.rul''' - defines the missionZones; and provides a link to textures (=battlescape appearance)
** Note: textures can be either terrain-based (used for UFO landing/crash sites) or alienDeployment-based (used for mission sites)
* '''globe.rul''' - defines the textures
** Note: the alienDeployment-based textures are usually recognizable by their negative IDs
* '''alienDeployments.rul''' - contains detailed information for the battlescape map generator (terrains, mapScripts, etc.)

=== Arc Scripts ===

<div style="background:#ddffdd;">
ArcScripts determine high-level game progression. They are executed just before the monthly MissionScripts.

Technically they are just "time-triggered research discoveries". More info: https://openxcom.org/forum/index.php/topic,7125.0.html
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| Name of the arc script used for overwriting or deleting purposes.
| ''required''
|- style="background-color:#ddffdd;"
| '''sequentialArcs'''
| The names of research topics to be "discovered", each month 0 or 1, processed sequentially.
| -
|- style="background-color:#ddffdd;"
| '''randomArcs'''
| The names and weights of research topics to be "discovered", each month 0 or 1, chosen randomly considering weights.
| -
|- style="background-color:#ddffdd;"
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game.
| 0
|- style="background-color:#ddffdd;"
| '''lastMonth'''
| Do not run after this month. -1 denotes no limit.
| -1
|- style="background-color:#ddffdd;"
| '''executionOdds'''
| % chances of this command executing.
| 100
|- style="background-color:#ddffdd;"
| '''maxArcs'''
| Maximum number of arcs this command can generate (together during the whole game), -1 for infinite.
| -1
|- style="background-color:#ddffdd;"
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|- style="background-color:#ddffdd;"
| '''maxDifficulty'''
| This command only applies to difficulty levels of this or below.
| 4
|- style="background-color:#ddffdd;"
| '''minScore'''
| This command only applies if last month's rating was above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxScore'''
| This command only applies if last month's rating was below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''minFunds'''
| This command only applies if the new month's funds are above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxFunds'''
| This command only applies if the new month's funds are below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''missionVarName'''<br/>'''missionMarkerName'''
| These variables allow accessing internal mission script tracking variables (see '''varName'''), or internal object counters.

More info: https://openxcom.org/forum/index.php/topic,10318.0.html
| -
|- style="background-color:#ddffdd;"
| '''counterMin'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at least this number.
| 0
|- style="background-color:#ddffdd;"
| '''counterMax'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at most this number. -1 denotes no limit
| -1
|- style="background-color:#ddffdd;"
| '''researchTriggers'''
| A list of research topics that can influence the execution of this script. For example 
* "''STR_MARTIAL_SOLUTION: true''" means the command would only run if the player has researched The Martian Solution.
* "''STR_CYDONIA_OR_BUST: false''" means the command would only run if the player has not researched Cydonia or Bust yet.
Several research triggers can be combined and all must be fulfilled. 
| -
|- style="background-color:#ddffdd;"
| '''itemTriggers'''
| A list of items that can influence the execution of this script. Similar to research triggers; checks the presence of items in the base stores (not anywhere else).
| -
|- style="background-color:#ddffdd;"
| '''facilityTriggers'''
| A list of base facilities that can influence the execution of this script. Similar to research triggers; checks the presence of a facility (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''soldierTypeTriggers'''
| A list of soldier types that can influence the execution of this script. Similar to research triggers; checks the presence of a soldier type (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''pactCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks if the country has (or hasn't) signed a pact with aliens.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInRegionTriggers'''
| A list of regions that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given region.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given country.
| -
|}

==== Guidelines/Tips ====

<div style="background:#ddffdd;">
Possible usage, for inspiration:
* Randomly give the player research A, B or C at the beginning - each research then unlocks specific tech at game start, giving the player different starting items/research for each new campaign
* Randomly give the player (each month) one research topic D, E, F, etc. - each research then unlocks specific mission(s) for that month
* Give tech G on month 0, tech H on month 1 and tech I on month 2 - for multi-mission story arcs spawning in sequence across several months
* Give tech J and spawn corresponding mission, if mission is victory receive tech K, which then unlocks additional mission next month - for making missions dependent on the previous one
* If research L is completed or if month X is achieved, give tech M at beginning of next month with the UFOPedia notification - this can be used to provide tips, tutorials, in-game message, whatever relevant info you want to give the player
</div>

=== Event Scripts ===

<div style="background:#ddffdd;">
EventScripts determine when custom geoscape events occur. They are executed just after the monthly MissionScripts.

More info: https://openxcom.org/forum/index.php/topic,7215.msg116753.html#msg116753
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''type'''
| Name of the event script used for overwriting or deleting purposes.
| ''required''
|- style="background-color:#ddffdd;"
| '''oneTimeSequentialEvents'''
| The list of one time sequential events to spawn. First not-previously-generated event is spawned.
| -
|- style="background-color:#ddffdd;"
| '''oneTimeRandomEvents'''
| The list of one time events to spawn. One random not-previously-generated event is spawned. Weights are considered.
| -
|- style="background-color:#ddffdd;"
| '''eventWeights'''
| The type of events to spawn. These are split into monthly chunks, and can contain multiple entries including weighted odds.
| -
|- style="background-color:#ddffdd;"
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game.
| 0
|- style="background-color:#ddffdd;"
| '''lastMonth'''
| Do not run after this month. -1 denotes no limit.
| -1
|- style="background-color:#ddffdd;"
| '''executionOdds'''
| % chances of this command executing.
| 100
|- style="background-color:#ddffdd;"
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|- style="background-color:#ddffdd;"
| '''maxDifficulty'''
| This command only applies to difficulty levels of this or below.
| 4
|- style="background-color:#ddffdd;"
| '''minScore'''
| This command only applies if last month's rating was above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxScore'''
| This command only applies if last month's rating was below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''minFunds'''
| This command only applies if the new month's funds are above this threshold. Not checked before first month.
| -infinity
|- style="background-color:#ddffdd;"
| '''maxFunds'''
| This command only applies if the new month's funds are below this threshold. Not checked before first month.
| infinity
|- style="background-color:#ddffdd;"
| '''missionVarName'''<br/>'''missionMarkerName'''
| These variables allow accessing internal mission script tracking variables (see '''varName'''), or internal object counters.

More info: https://openxcom.org/forum/index.php/topic,10318.0.html
| -
|- style="background-color:#ddffdd;"
| '''counterMin'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at least this number.
| 0
|- style="background-color:#ddffdd;"
| '''counterMax'''
| This script command only applies if the corresponding counter ('''missionVarName''' or '''missionMarkerName''') is at most this number. -1 denotes no limit
| -1
|- style="color:#666666;"
| '''missionMinRuns'''
| ''Deprecated:'' use '''counterMin''' instead.
| -
|- style="color:#666666;"
| '''missionMaxRuns'''
| ''Deprecated:'' use '''counterMax''' instead.
| -
|- style="background-color:#ddffdd;"
| '''researchTriggers'''
| A list of research topics that can influence the execution of this script. For example 
* "''STR_MARTIAL_SOLUTION: true''" means the command would only run if the player has researched The Martian Solution.
* "''STR_CYDONIA_OR_BUST: false''" means the command would only run if the player has not researched Cydonia or Bust yet.
Several research triggers can be combined and all must be fulfilled. 
| -
|- style="background-color:#ddffdd;"
| '''itemTriggers'''
| A list of items that can influence the execution of this script. Similar to research triggers; checks the presence of items in the base stores (not anywhere else).
| -
|- style="background-color:#ddffdd;"
| '''facilityTriggers'''
| A list of base facilities that can influence the execution of this script. Similar to research triggers; checks the presence of a facility (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''soldierTypeTriggers'''
| A list of soldier types that can influence the execution of this script. Similar to research triggers; checks the presence of a soldier type (in any xcom base).
| -
|- style="background-color:#ddffdd;"
| '''pactCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks if the country has (or hasn't) signed a pact with aliens.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInRegionTriggers'''
| A list of regions that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given region.
| -
|- style="background-color:#ddffdd;"
| '''xcomBaseInCountryTriggers'''
| A list of countries that can influence the execution of this script. Similar to research triggers; checks the presence (or absence) of an xcom base in a given country.
| -
|- style="background-color:#ddffdd;"
| '''affectsGameProgression'''
| If set to true, research topics from '''researchTriggers''' will display a small disclaimer in the TechTreeViewer about affecting game progression.
| false
|}

==== Events ====

<div style="background:#ddffdd;">
Defines a Geoscape event that pops up, gives the player some background info and awards funds, score, items and/or research, listed in ''"events:"''.

More info: https://openxcom.org/forum/index.php/topic,7215.msg116753.html#msg116753
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''name'''
| String ID of the event name. Use {0} placeholder (in the actual translation) for region/city name.
| ''required''
|- style="background-color:#ddffdd;"
| '''adhocMissionScriptTags'''
| Tags to be considered during the adhoc mission script command execution.

More info: https://openxcom.org/forum/index.php?topic=12338.msg171478#msg171478
| -
|- style="background-color:#ddffdd;"
| '''description'''
| String ID of the event description. Use {0} placeholder (in the actual translation) for region/city name.
| -
|- style="background-color:#ddffdd;"
| '''alignBottom'''
| Should the description be bottom-aligned?
| false
|- style="background-color:#ddffdd;"
| '''background'''
| String ID of the background image to use in the window when this event pops up on the Geoscape.
| BACK13.SCR
|- style="background-color:#ddffdd;"
| '''music'''
| String ID of the music to play when this event pops up on the Geoscape.
| -
|- style="background-color:#ddffdd;"
| '''cutscene'''
| String ID of the cutscene to play when this event's window is closed.
| -
|- style="background-color:#ddffdd;"
| '''regionList'''
| List of regions, where this event can occur. The region name can be a part of the event name and/or description.
| -
|- style="background-color:#ddffdd;"
| '''city'''
| Whether or not the event occurs in a random city (of the given region(s)). The city name can be a part of the event name and/or description.
| false
|- style="background-color:#ddffdd;"
| '''points'''
| How many score/rating points are awarded to xcom when this event pops up. If there is a region, points are awarded to that region's activity, otherwise to the research score.
| 0
|- style="background-color:#ddffdd;"
| '''funds'''
| How much money is awarded to xcom when this event pops up.
| 0
|- style="background-color:#ddffdd;"
| '''spawnedCraftType'''
| Allows to "hire" craft.

More info here: https://openxcom.org/forum/index.php?topic=11201.msg161177#msg161177
| -
|- style="background-color:#ddffdd;"
| '''spawnedPersons'''
| Number of spawned persons.
| 0
|- style="background-color:#ddffdd;"
| '''spawnedPersonType'''
| Allows to "hire" soldiers, scientists and engineers.

More info here: https://openxcom.org/forum/index.php/topic,7215.msg132650.html#msg132650
| -
|- style="background-color:#ddffdd;"
| '''spawnedPersonName'''
| When "hiring" a soldier, you can (optionally) specify also his/her name. The name is translatable.
| -
|- style="background-color:#ddffdd;"
| '''spawnedSoldier'''
| When "hiring" a soldier, you can (optionally) specify overrides for any of the soldier's attributes. Uses the same syntax as the saved games. Cannot override soldier's ID and name.
| -
|- style="background-color:#ddffdd;"
| '''everyItemList'''
| A list of item IDs. When this event pops up they are all transferred to the HQ (within 1 hour).
| -
|- style="background-color:#ddffdd;"
| '''everyMultiItemList'''
| A list of item IDs and their quantities. When this event pops up they are all transferred to the HQ (within 1 hour).
| -
|- style="background-color:#ddffdd;"
| '''randomItemList'''
| A list of item IDs. When this event pops up one of them is selected randomly and transferred to the HQ (within 1 hour).
| -
|- style="background-color:#ddffdd;"
| '''randomMultiItemList'''
| A list of "lists of item IDs and their quantities". When this event pops up one of the lists is selected randomly and everything in that list is transferred to the HQ (within 1 hour).
| -
|- style="background-color:#ddffdd;"
| '''weightedItemList'''
| A weighted list of item IDs. When this event pops up one of them is selected randomly (respecting given weights) and transferred to the HQ (within 1 hour).
| -
|- style="background-color:#ddffdd;"
| '''researchList'''
| A list of research topic IDs. One (from the not-yet-discovered) is randomly selected when this event pops up and granted for free.
| -
|- style="background-color:#ddffdd;"
| '''interruptResearch'''
| String ID of a research topic that will prevent (an already generated/scheduled) event from popping up.
| -
|- style="background-color:#ddffdd;"
| '''timer'''
| Number of minutes (after generation) after which the event should pop up. Minimum is 60. Should be a multiple of 30.
| 60
|- style="background-color:#ddffdd;"
| '''timerRandom'''
| Additional random timer in minutes. Total delay = '''timer''' + RNG(0, '''timerRandom''').
| 0
|- style="background-color:#ddffdd;"
| '''invert'''
| If enabled, the event will remove items instead of generating new items.
| false
|- style="background-color:#ddffdd;"
| '''everyMultiSoldierList'''
| A list of soldier type IDs and their quantities. When this event pops up they are all transferred to the HQ (within 1 hour).

More info: https://openxcom.org/forum/index.php?topic=12646.msg172046#msg172046
| -
|- style="background-color:#ddffdd;"
| '''randomMultiSoldierList'''
| A list of "lists of soldier type IDs and their quantities". When this event pops up one of the lists is selected randomly and everything in that list is transferred to the HQ (within 1 hour).
| -
|}

=== Alien Tech Levels ===

This is a list of alien Tech Levels, listed in ''"alienItemLevels:"''.

Each line in the list corresponds to the Tech Level for one game month (first line is for the first month, second line for second month, etc.). The game will use the most recent available line in the event the game goes on forever (and there are not enough lines defined).

Each line contains item set probabilities, with a number between 0 and 2 representing an item set (from plasma pistols to heavy plasmas, as defined in the deployments), expressing a 10% probability for that item set being used.

* 0 = first item set (e.g. plasma pistol/clip)
* 1 = second item set (e.g. plasma rifle/clip)
* 2 = third item set (e.g. heavy plasma/clip)

For example:
  [ 2, 0, 0, 0, 0, 0, 0, 1, 1, 1 ]
would represent a 60% chance for pistols, 30% for rifles and 10% for heavy weapons.

Note that the order does not matter, but the length DOES. Each line MUST have exactly 10 digits.

If the above is still confusing, here's more explanation:
* There are 10 fields in a line; each field represents 10%
* There are six instances of '0'... 6x10% = 60% chance of plasma pistol
* There are three instances of '1'... 3x10% = 30% chance of plasma rifle
* There is only one instance of '2'... 1x10% = 10% chance of heavy plasma

Just in case: you can use more (or less) than 3 item sets (0, 1, 2), but you will need to modify all the alien deployments accordingly too!

=== Extra Sprites ===

Adds or replaces sprites in an existing [[Image Formats|X-COM image file]], listed in ''"extraSprites:"''.

'''VERY IMPORTANT:'''
* You can use many different image formats, but not all of them work on all platforms (e.g. 8bit GIF does '''not''' work on Mac)... please use 8bit PNG format for maximum compatibility
* OpenXcom is able to handle 24bit images (in some cases), but they are '''not''' officially supported... please use 8bit images for maximum compatibility
* OpenXcom is able to handle transparency index other than zero (in most cases), but it is '''not''' officially supported... please use transparency index zero for maximum compatibility
* OpenXcom displays '''everything''' using 8bit palettes
** you can find '''official''' palettes for both UFO and TFTD (in various formats) here: https://github.com/MeridianOXC/OpenXcom/tree/oxce-plus/bin/common/Palettes
** '''FIXME''': add a detailed guide describing which palettes are used for which images

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Name of the original sprite/spritesheet to modify or new sprite/spritesheet to create.
| ''required''
|- style="background-color:#ddffdd;"
| '''typeSingle'''
| Alternative to '''type''', used for defining single sprites with less verbose ruleset. Changes the default value for '''singleImage''' to ''true''.
| -
|-
| '''files'''
| List of the new sprites to add/replace, listed as ''spriteID: filepath''.
| -
|- style="background-color:#ddffdd;"
| '''fileSingle'''
| Alternative to '''files''', used for defining single sprites with less verbose ruleset.
| -
|-
| '''width'''
| Width of the whole sprite/spritesheet in pixels.
| 320
|-
| '''height'''
| Height of the whole sprite/spritesheet in pixels.
| 200
|-
| '''singleImage'''
| Is the image file just a single sprite (true) or a spritesheet (false)?
| false
|-
| '''subX'''
| Width of the subdivision in pixels. If a subdivision is specified, then the image file (a spritesheet) is divided into chunks (sprites).
| 0
|-
| '''subY'''
| Height of the subdivision in pixels. If a subdivision is specified, then the image file (a spritesheet) is divided into chunks (sprites).
| 0
|}

Example:
 - type: GIANTBUNNY.PCK
   width: 32
   height: 40
   files:
     0: Resources/Bunny/Bunny00.png
     1: Resources/Bunny/Bunny01.bmp
     2: Resources/Bunny/Bunny02.gif

Another example: (takes advantage of the ability to drop numerous images into a single folder that will then behave like a spritesheet)

 - type: GIANTBUNNY.PCK
   width: 32
   height: 40
   files:
     0: Resources/Bunny/sprite/

Files within the specified folder should be numbered sequentially from the number defined above. "0" in this case.

==== Negative indices and cross-referencing other mods ====

Since Q2/2019, it is officially not possible to use negative sprite and sound indices (both in OXC and OXCE).

The xcom1 terror weapons (their bigobs) have been moved to positive indices as follows:
* Chrysssalid weapon from -1 to 61
* Cyberdisc/Celatid/Sectopod weapon from -2 to 60
* Reaper weapon from -3 to 59
* Silacoid weapon from -4 to 58
* Zombie weapon from -5 to 57

Similar mapping was done also for xcom2 terror weapons.

If you were using these bigobs in your mod, you have 2 options how to fix it:
# Option 1 (recommended): define/copy these bigobs in your mod as any other custom sprites, i.e. don't reuse the openxcom ones
# Option 2: you can reuse the openxcom ones using a special syntax, which allows you to access objects from different mods, see example below

  items:
    - type: STR_MY_CUSTOM_SECTOPOD_WEAPON
      bigSprite: { mod: xcom1, index: 60 }

This example shows how to access sprite number 60 from xcom1 mod. There is also a special keyword '''master''', which allows you to access the master mod. The following example is equivalent to the previous example:

  items:
    - type: STR_MY_CUSTOM_SECTOPOD_WEAPON
      bigSprite: { mod: master, index: 60 }

'''Disclaimer:''' please be careful when addressing other mods than your own, the mod authors may decide to change their numbering at any time, rendering your references incorrect. Using this feature for anything else than addressing xcom1/xcom2 terror weapons is at your own risk.

==== Alternative for single sprites (OXCE only) ====

<div style="background:#ddffdd;">Bigger mods can contain '''a lot''' of sprites.

To make the ruleset smaller and easier to read, you can use the following alternative way of defining single sprites.

Standard method:

  - type: SpriteName
    singleImage: true
    files:
      0: Resources/MyImage.png 

Alternative method:

  - typeSingle: SpriteName
    fileSingle: Resources/MyImage.png 

Notice how only 2 lines are needed instead of 4; and the beginning of both values is nicely aligned.
</div>

==== Reserved sprite/spritesheet names ====

'''FIXME''': add info about reserved names in OpenXcom too.

<div style="background:#ddffdd;">
OXCE adds several new sprites and spritesheets with pre-defined names, that serve various purposes. Most of these sprites are "empty" by default and not used. But modders have the option to define these sprites and activate extra functionality behind them.

Below is the list of new sprites and spritesheets ('''FIXME''': add description and links/examples):
* '''spritesheets''':
** CustomArmorPreviews
** CustomItemPreviews
** DayNightIndicator
** TinyRanks
* '''sprites''':
** AvatarBackground
** AlienInventory, AlienInventory2
** BigStunIndicator, BigWoundIndicator, BigBurnIndicator, BigShockIndicator
** FloorStunIndicator, FloorWoundIndicator, FloorBurnIndicator, FloorShockIndicator
** Flag[X]
</div>

=== Extra Sounds ===

Adds or replaces sounds in an existing [[SOUND|X-COM sound file]], listed in ''"extraSounds:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| ID of the original sound file to modify:
* BATTLE.CAT - Battlescape sounds, corresponds to ''SOUND1.CAT'' or ''SAMPLE2.CAT'' (55 sounds).
* INTRO.CAT - Intro sounds, corresponds to ''INTRO.CAT'' or ''SAMPLE3.CAT'', probably best not to mess with these.
* GEO.CAT - Geoscape sounds, corresponds to ''SOUND2.CAT'' or ''SAMPLE.CAT'' (14 sounds).
| ''required''
|-
| '''files'''
| List of the new sounds to add/replace, listed as ''soundID: filepath''.
| -
|}

Example:
 - type: BATTLE.CAT
   files:
     55: Resources/Sounds/sample.wav

<div style="background:#ffdddd;">
'''When using .wav files, please pay attention to the file format!'''

OpenXcom should work fine with:
* uncompressed mono/stereo PCM
* low bit depth (8bit or 16bit), '''16bit recommended''', 24bit is known to NOT work
* low and standard sample rates (8-48 kHz), 22050 Hz or 44100 Hz recommended
</div>

=== Music ===

Custom music options can be defined in the Music.rul file.  More details [[Audio Options (OpenXcom)#Custom Music|here]].

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Internal name of the music track.
| ''required''
|-
| '''name'''
| Name of the music track. If empty, '''type''' is used as name.
| -
|-
| '''catPos'''
| The track's index in the catalog (CAT) file. Only relevant for music stored in CAT files, obviously.
| -
|-
| '''normalization'''
| The track's normalization level. Only relevant for music stored in CAT files.
| 0.76
|}

=== Extra Strings ===

Adds or replaces text strings in an existing [[Translations (OpenXcom)|OpenXcom language file]], listed in ''"extraStrings:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original language file to modify (without file extension).
| ''required''
|-
| '''strings'''
| List of the new strings to add/replace, listed as ''stringID: text''.
| -
|}

Example:
 - type: en-US
   strings:
     STR_SNIPER_RIFLE: Sniper Rifle
     STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
 - type: en-GB
   strings:
     STR_SNIPER_RIFLE: Sniper Rifle
     STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
 - type: de
   strings:
     STR_SNIPER_RIFLE: Scharfschützengewehr
     STR_SNIPER_RIFLE_CLIP: Scharfschützengewehrmunition
 - type: ru
   strings:
     STR_SNIPER_RIFLE: Снайперская винтовка
     STR_SNIPER_RIFLE_CLIP: Магазин к снайп. винтовке

'''Did you know?'''
* Translations can also be provided in the same format as OpenXcom provides them for default languages (en-US and en-GB)
* The advantage over using extraStrings is that the format can be used in Transifex, so that popular mods can be easily translated into many languages by many people in a more coordinated way

=== Interfaces ===

Defines various properties (most notably colors) and behavior of OpenXcom UI screens, listed in ''"interfaces:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| Name of the interface. Each OpenXcom screen has a unique corresponding interface.
| ''required''
|-
| '''palette'''
| Name of the palette (e.g. PAL_BASESCAPE) to be used for this screen. Not all screens support this.
| -
|-
| '''parent'''
| Name of the parent interface (from which some attributes are inherited).

For example research/manufacture screens have a hierarchy of screens opening on top of each other.
| -
|-
| '''music'''
| Music to play when the corresponding screen is opened.
| -
|- style="background-color:#ddffdd;"
| '''sound'''
| Sound effect (from GEO.CAT) to play when the corresponding screen is opened.
| -1
|- style="background-color:#ddffdd;"
| '''backgroundImage'''
| Background image for the corresponding screen.
| -
|- style="background-color:#ddffdd;"
| '''altBackgroundImage'''
| Alternative background image for the corresponding screen (in battlescape theme). Used for UIs that can be displayed both in geoscape and battlescape mode.
| -
|- style="background-color:#ddffdd;"
| '''upgBackgroundImage'''
| Background image upgrades, by research.

More info: https://openxcom.org/forum/index.php?topic=12711.0
| -
|-
| '''elements'''
| List of detailed definitions for various elements on the screen (window, text, buttons, lists, etc.). See below.
| -
|}

==== Elements ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''id'''
| Name of the interface element.
| ''required''
|-
| '''size'''
| Some elements have configurable size. Defined as [width, height].
| -
|-
| '''pos'''
| Some elements have configurable position. Defined as [x, y], where x<320 and y<200.
| -
|-
| '''color'''
| Most elements have configurable primary color (0-255). Elements called ''palette'' only have range between 0-15 (palette offsets).
| -
|-
| '''color2'''
| Some elements have configurable alternative/secondary color (0-255).
| -
|-
| '''border'''
| Some elements have configurable border/tertiary color (0-255).
| -
|- style="background-color:#ddffdd;"
| '''custom'''
| A generic-purpose attribute.

Currently used only for inventory interface, specifies which stats are displayed.
| 0
|-
| '''TFTDMode'''
| Is used in TFTD for inversion behavior in some elements, mostly buttons.
| -
|}

'''Tip''': which elements support which attributes can be determined by inspecting the vanilla xcom1/xcom2 ruleset.

=== StatStrings ===

[[Statstrings]] are used to automatically rename soldiers. They are case-sensitive and processed in the order in which they are specified. Processing is stopped either at the end of the list, or when a first rule with a name longer than 1 character (e.g. "Snpr") matches.

<div style="background:#ddffdd;">
Since OXCE v7.2, you can use also non-ASCII characters and they will be correctly counted as only 1 character.

In OpenXcom, they will still count as multiple characters and will stop the processing (as described above).
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''string'''
| String to add to name.
| ''required''
|-
| '''psiStrength'''<br>
'''psiSkill'''<br>
'''bravery'''<br>
'''strength'''<br>
'''firing'''<br>
'''reactions'''<br>
'''stamina'''<br>
'''tu'''<br>
'''health'''<br>
'''throwing'''
| One or more stat ranges are AND-ed together to find a match.

Each range has a format [min, max]. Use YAML standard tilde (~) to indicate empty value (interpreted as 0 for min and as 255 for max).
| -
|-
| '''melee'''<br>
'''psiTraining'''
| New attributes (only available in OpenXcom).
| -
|- style="background-color:#ddffdd;"
| '''manaPool'''
| New attribute (only available in OXCE).
| -
|}

Example:
  statStrings:
  - string: "x"
    psiStrength: [~, 30]
  - string: "P"
    psiStrength: [80, ~]
  - string: "p"
    psiStrength: [60, 79]
  - string: "K"
    psiSkill: [60, ~]
  - string: "k"
    psiSkill: [30, 59]
  - string: "b"
    bravery: [60, ~]
  - string: "c"
    bravery: [~, 10]
  - string: "w"
    strength: [~, 25]
  - string: "Snpr"
    firing: [60, ~]
    reactions: [60, ~]
  - string: "M"
    firing: [70, ~]
  - string: "m"
    firing: [60, 69]
  - string: "Sct"
    reactions: [50, ~]
    tu: [60, ~]
  - string: "R"
    reactions: [60, ~]
  - string: "r"
    reactions: [50, 59]

=== Cutscenes ===

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|- style="background-color:#ddffdd;"
| '''winGame'''
| Whether or not the cutscene ends the game with victory.

More info about multiple game endings: https://openxcom.org/forum/index.php/topic,7476.0.html
| false
|- style="background-color:#ddffdd;"
| '''loseGame'''
| Whether or not the cutscene ends the game with defeat.
| false
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie.  This should only ever be set to true for the UFO intro.
| false
|-
| '''videos'''
| A list of video filenames to play with the FLC player. Required if this cutscene is a video playlist.
| -
|-
| '''audioTracks'''
| A list of audio filenames to play along the videos specified in '''videos'''. Optional.
| -
|-
| '''slideshow'''
| Info for playing a slideshow (see below). Required if this cutscene is a slideshow.
| -
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide.  The user can always force a transition by a mouse click.
| 30
|-
| '''musicId'''
| The ID of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background.

'''Note''': the palette for the slide is taken directly from the image, so the caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|-
| '''transitionSeconds'''
| Override for '''transitionSeconds''' from Slideshow Data, so that each slide can have a different value.
| 0
|-
| '''captionAlign'''
| The horizontal text alignment for the caption text. Possible values: 0 = left, 1 = center, 2 = right.
| 0
|- style="background-color:#ddffdd;"
| '''captionVerticalAlign'''
| The vertical text alignment for the caption text. Possible values: 0 = top, 1 = middle, 2 = bottom.
| 0
|}

=== Global Variables ===

The following ruleset doesn't belong into any category/hierarchy, it's just standalone settings you can put into any file, on the top level. It mostly contains constants that were deemed worthy making moddable.

In vanilla ruleset files, these are located in ''vars.rul'' and in ''difficulty.rul''.

==== Resources ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|- style="background-color:#ddffdd;"
| '''disableUnderwaterSounds'''
| Redirects the game to BATTLE.CAT whenever it would want to access BATTLE2.CAT, i.e. underwater sounds will be the same as surface sounds.

Hint: a debug option for people working on hybrid UFO/TFTD mods to (for the time being) prevent crashes on missing sounds.
| false
|- style="background-color:#ddffdd;"
| '''enableUnitResponseSounds'''
| Enables/disables unit response sounds.

More info: https://openxcom.org/forum/index.php/topic,7371.0.html
| false
|- style="background-color:#ddffdd;"
| '''unitResponseSoundsFrequency'''
| Sets the probabilities of unit response sounds being played (each time). First number is for "select unit" sound, second for "start moving" sound, third for "select weapon" sound and fourth for the "annoyed" sound.
| [100, 100, 100, 20]
|- style="background-color:#ddffdd;"
| '''unitResponseSounds'''
| Custom unit response sounds per individual soldier name... when soldier type/armor/gender is just not RPG enough :) Hardcore.

More info: https://openxcom.org/forum/index.php/topic,7371.0.html

Syntax:

  unitResponseSounds:
    - name: Starving Poet
      selectUnitSound:   [200, 201, 202, 203, 204]
      startMovingSound:  [210, 211, 212, 213]
      selectWeaponSound: [220, 221, 222, 223]
      annoyedSound:      [230, 231, 232, 233]
    - name: Ivan Dogovich
      selectUnitSound:   [300, 301, 302, 303, 304, 305]
      startMovingSound:  [310, 311, 312, 313]
      selectWeaponSound: [320, 321, 322, 323]
      annoyedSound:      [330, 331, 332, 333, 334, 335]
| -
|- style="background-color:#ddffdd;"
| '''baseNamesFirst'''<br>
'''baseNamesMiddle'''<br>
'''baseNamesLast'''
| Data for the random base name generator. '''baseNamesMiddle''' and '''baseNamesLast''' are optional. Example:

  baseNamesFirst:
    - Big
    - Huge
    - Large
    - Stinky
  baseNamesMiddle:
    - Rat
    - Pirate
  baseNamesLast:
    - Bay
    - Port
    - Haven
    - Tavern
| -
|- style="background-color:#ddffdd;"
| '''operationNamesFirst'''<br>
'''operationNamesLast'''
| Data for the random operation name generator. '''operationNamesLast''' is optional. Example:

  operationNamesFirst:
    - Blind
    - Burning
    - Cold
    - Dark
    - Devil's
    - Enduring
    - Fallen
  operationNamesLast:
    - Blade
    - Dream
    - Future
    - Justice
    - Rain
    - Star
    - Thunder
| -
|}

==== Сampaign ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''startingTime'''
| Specifies the date and time at the beginning of the game.
Example:
  startingTime:
    second: 0
    minute: 0
    hour: 12
    weekday: 6      # 1 = Sunday, 7 = Saturday
    day: 1
    month: 1
    year: 1999
| Friday 1.1.1999 12:00:00
|-
| '''initialFunding'''
| Amount of money (in thousands of dollars) the player starts with.
| 0
|- style="background-color:#ddffdd;"
| '''monthlyRatings'''
| A list of monthly ratings. Each item contains a minimum required score and a corresponding String ID of the rating. Example:

  monthlyRatings:
    5000: STR_MT_RATING_AMAZING
    2000: STR_MT_RATING_PERFECT
    1000: STR_MT_RATING_VERY_GOOD
    500: STR_MT_RATING_GOOD
    250: STR_MT_RATING_OK
    0: STR_MT_RATING_MEH
    -350: STR_MT_RATING_BAD
    -99999: STR_MT_RATING_TERRIBLE

| -
|- style="background-color:#ddffdd;"
| '''performanceBonusFactor'''
| Defines whether the player receives a financial bonus based on the monthly score. If set for example to 1000 and monthly score is 650, the player receives an extra $650000. In case of a negative monthly score, there is no penalty.

Note: since OXCE v7.15, the factor can be also a decimal number, not only an integer number.
| 0
|- style="background-color:#ddffdd;"
| '''customTrainingFactor'''
| Additional RNG for stat improvement using martial/combat training facilities. Can be used to slow down training (cannot speed it up). If set for example to 20, the training speed will be five times slower than normal (i.e. training at 20% speed).
| 100
|- style="background-color:#ddffdd;"
| '''psiUnlockResearch'''
| In OpenXcom, this is set to Psi-Lab requirements (i.e. the building with '''psiLabs''' > 0). In OXCE, you can set a different research topic to allow Psi screening (using the ''Psi-Strength Evaluation'' advanced option) before the actual Psi training (in Psi Labs) is possible.
| -
|- style="background-color:#ddffdd;"
| '''fakeUnderwaterBaseUnlockResearch'''
| Research topic required to be able to build bases on "fake underwater" globe textures.
| -
|- style="background-color:#ddffdd;"
| '''newBaseUnlockResearch'''
| Research topic required to be able to build new bases on any globe texture.
| -
|- style="background-color:#ddffdd;"
| '''allowAlienBasesOnWrongTextures'''
| If a valid location cannot be found after 100 random attempts, use an invalid location (land texture vs. fake underwater texture).
| true
|- style="background-color:#ddffdd;"
| '''allowCountriesToCancelAlienPact'''
| If enabled, XCOM can convince countries that left the XCOM project to come back... by destroying the alien base that was created when the aliens signed a pact with a given country.
| false
|- style="background-color:#ddffdd;"
| '''buildInfiltrationBaseCloseToTheCountry'''
| If enabled, alien infiltration bases will be built in or near the infiltrated country (as opposed to anywhere in the whole region).
| false
|- style="background-color:#ddffdd;"
| '''infiltrateRandomCountryInTheRegion'''
| If enabled, alien infiltration within a region will be randomized.
| false
|- style="background-color:#ddffdd;"
| '''chanceToStopRetaliation'''
| If an XCOM base is found and a battleship sent to attack it is shot down by base defense facilities, aliens will keep sending new battleships potentially for a long time. This setting defines a chance that they reconsider their decision (after each failed attack) and stop sending more battleships.
| 0
|- style="background-color:#ddffdd;"
| '''chanceToDetectAlienBaseEachMonth'''
| Chance to detect an alien base by Xcom Operatives at the end of month.
| 20
|- style="background-color:#ddffdd;"
| '''lessAliensDuringBaseDefense'''
| If enabled, less aliens will spawn in base defense missions, roughly proportional to damage dealt to the invading UFO. At least one alien of each rank is guaranteed to spawn.
| false
|- style="background-color:#ddffdd;"
| '''gameOver'''
| A list of cutscene names for special events. More info: https://openxcom.org/forum/index.php/topic,7476.msg117830.html#msg117830

  gameOver:
    loseMoney: loseGame       # cutscene ID that should be played when the player loses due to poor economy management
    loseRating: loseGame      # cutscene ID that should be played when the player loses due to poor rating
    loseDefeat: loseGame      # cutscene ID that should be played when the player loses the last base
| <=
|}

==== Basescape/Personnel ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''timePersonnel'''
| Time (in hours) it takes for newly hired personnel to arrive at a base.
| 0
|- style="background-color:#ddffdd;"
| '''hireByCountryOdds''' '''hireByRegionOdds'''
| Used to define the odds of attempting to name the soldier based on the country/region where it was hired.

More info: https://openxcom.org/forum/index.php/topic,10845.0.html
| 0
|-
| '''costEngineer'''
| Monthly salary of a single engineer (in dollars). Please note that hiring cost is twice as much.
| 0
|- style="background-color:#ddffdd;"
| '''costHireEngineer'''
| Cost of hiring a single engineer. If not specified (0), it costs twice as much as the monthly salary.
| 0
|- style="background-color:#ddffdd;"
| '''hireEngineersUnlockResearch'''
| Research topic required to be able to hire engineers.
| -
|- style="background-color:#ddffdd;"
| '''hireEngineersRequiresBaseFunc'''
| A list of base services required to be able to hire engineers.
| -
|-
| '''costScientist'''
| Monthly salary of a single scientist (in dollars). Please note that hiring cost is twice as much.
| 0
|- style="background-color:#ddffdd;"
| '''costHireScientist'''
| Cost of hiring a single scientist. If not specified (0), it costs twice as much as the monthly salary.
| 0
|- style="background-color:#ddffdd;"
| '''hireScientistsUnlockResearch'''
| Research topic required to be able to hire scientists.
| -
|- style="background-color:#ddffdd;"
| '''hireScientistsRequiresBaseFunc'''
| A list of services required to be able to hire scientists.
| -
|- style="background-color:#ddffdd;"
| '''soldiersPerSergeant'''
| How many soldiers (of any rank) are required to unlock a new sergeant promotion.
| 5
|- style="background-color:#ddffdd;"
| '''soldiersPerCaptain'''
| How many soldiers (of any rank) are required to unlock a new captain promotion.
| 11
|- style="background-color:#ddffdd;"
| '''soldiersPerColonel'''
| How many soldiers (of any rank) are required to unlock a new colonel promotion.
| 23
|- style="background-color:#ddffdd;"
| '''soldiersPerCommander'''
| How many soldiers (of any rank) are required to unlock the commander promotion. There can be only one commander at a time.
| 30
|- style="background-color:#ddffdd;"
| '''shortRadarRange'''
| The maximum radar range still considered as short (for [Base Info] screen purposes). If not specified (0), the smallest range from all radar facilities is used.
| 0
|- style="background-color:#ddffdd;"
| '''buildTimeReductionScaling'''
| When upgrading base facilities, reduce the build time reduction by this factor (in percent). Or in simpler words, increase the upgrade time.
| 100
|- style="background-color:#ddffdd;"
| '''enableNewResearchSorting'''
| If enabled, the player will be able to sort the list of available research topics by name and cost.
| false
|- style="background-color:#ddffdd;"
| '''displayCustomCategories'''
| Should custom item categories be used in Buy/Sell/Transfer screens?
* 0 = no, only vanilla categories
* 1 = yes, only custom categories
* 2 = yes, both vanilla and custom categories
| 0
|- style="background-color:#ddffdd;"
| '''shareAmmoCategories'''
| If enabled, firearms will "inherit" the categories of their ammo (only the available ammo counts). Affected are: 1/ Craft Equipment screen and 2/ Starting conditions (allowed/disabled item categories). Not affected: Buy/Sell/Transfer screens.
| false
|- style="background-color:#ddffdd;"
| '''maxLookVariant'''
| The maximum supported lookVariant (0-63) used in [Change Soldier Avatar] dialog.
| 0
|- style="background-color:#ddffdd;"
| '''flagByKills'''
| OXCE allows to display flags next to soldier names, based on their nationality (resp. based on the name pool from which their name was chosen). If this setting is used, the flag will depend on the number of kills from soldier's diary instead.

  flagByKills: [10,20,30]

Example above means:
* 0-10 kills = Flag0 sprite is used
* 11-20 = Flag1 sprite
* 21-30 = Flag2 sprite
* 31+ = Flag3 sprite

| -
|- style="background-color:#ddffdd;"
| '''alienInventoryOffsetX'''
| Hand slots of the "alien inventory" (inventory accessible via Middle-button-click) will be shifted to the right by this much.
| 80
|- style="background-color:#ddffdd;"
| '''alienInventoryOffsetBigUnit'''
| Hand slots of the "alien inventory" (inventory accessible via Middle-button-click) will be shifted away from each other by this much for 2x2 units.
| 32
|}

==== Interception ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''selectBaseSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when a base is selected on the globe. Can be a list with multiple options.

More info: https://openxcom.org/forum/index.php/topic,10195.msg143054.html#msg143054
| -
|- style="background-color:#ddffdd;"
| '''startDogfightSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when a dogfight starts. Can be a list with multiple options.
| -
|- style="background-color:#ddffdd;"
| '''drawEnemyRadarCircles'''
| When should the alien UFO (hunter-killer) and alien base radar ranges be drawn? Possible options:
* 0 = never drawn
* 1 = drawn for bases if discovered and for UFOs if hyper-detected
* 2 = drawn for bases if discovered and for UFOs if detected
| 1
|- style="background-color:#ddffdd;"
| '''pilotAccuracyZeroPoint'''
| Average firing accuracy for a pilot (where the accuracy bonus is 0%).
| 55
|- style="background-color:#ddffdd;"
| '''pilotAccuracyRange'''
| The firing accuracy impact (as a percentage of the distance to the zero point) on the pilot's aim in dogfights.
| 40
|- style="background-color:#ddffdd;"
| '''pilotReactionsZeroPoint'''
| Average reactions for a pilot (where the dodge bonus is 0%).
| 55
|- style="background-color:#ddffdd;"
| '''pilotReactionsRange'''
| The reactions impact (as a percentage of the distance to the zero point) on the pilot's dodge ability in dogfights.
| 60
|- style="background-color:#ddffdd;"
| '''pilotBraveryThresholds'''
| The pilot's bravery needed for [Very Bold, Bold, Normal] approach speed during dogfights. If neither is reached, approach speed is Cowardly.
| [90, 80, 30]
|- style="background-color:#ddffdd;"
| '''showDogfightDistanceInKm'''
| Should the distance between the craft and a UFO be shown in kilometers (true) or in vanilla units (false)? Vanilla units equal to 8-times the distance in kilometers.
| false
|- style="background-color:#ddffdd;"
| '''ufoGlancingHitThreshold'''
| The threshold for defining a glancing hit on a UFO during interception. Defined as a percentage of damage needed to shoot it down (i.e. half of '''damageMax''').
| 0
|- style="background-color:#ddffdd;"
| '''ufoBeamWidthParameter'''
| The parameter for drawing the width of a UFO's beam weapon based on power. The width of the beam in pixels will be weapon power divided by this parameter, but at least 3 pixels. For example if the weapon power is 250 and parameter is 50, the beam size in pixels will be 5.
| 1000
|- style="background-color:#ddffdd;"
| '''ufoTractorBeamSizeModifiers'''
| The modifiers to a tractor beam's power based on a UFO's size.

  ufoTractorBeamSizeModifiers:
    - 400 # very small, tractor beams are 400% or 4x as effective
    - 200
    - 100
    - 50
    - 25 # very large, tractor beams are 25% or 1/4x as effective

| [400, 200, 100, 50, 25]
|- style="background-color:#ddffdd;"
| '''hunterKillerFastRetarget'''
| If enabled, the UFO hunter-killers can reconsider their target every 5 seconds on low game speeds (5sec/1min) and every 10 minutes on all other game speeds. If disabled, it is only every 10 minutes on all game speeds.
| true
|- style="background-color:#ddffdd;"
| '''escortRange'''
| Range (in nautical miles) in which the craft is considered to be escorted by a nearby craft.
| 20
|- style="background-color:#ddffdd;"
| '''escortsJoinFightAgainstHK'''
| Should craft escorts join the fight against HK automatically (true)? Or is only fighting one-on-one allowed (false)?
| true
|- style="background-color:#ddffdd;"
| '''crewEmergencyEvacuationSurvivalChance'''
| The chance of soldiers (that are not pilots) surviving craft destruction by a UFO hunter-killer (jumping out with a parachute).
| 100
|- style="background-color:#ddffdd;"
| '''pilotsEmergencyEvacuationSurvivalChance'''
| The chance of pilots surviving craft destruction by a UFO hunter-killer (emergency seat ejection).
| 100
|- style="background-color:#ddffdd;"
| '''showUfoPreviewInBaseDefense'''
| Show UFO preview in base defense?

Hint: also check '''instaHyper''' UFO attribute.
| false
|}

==== Pedia ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''pediaReplaceCraftFuelWithRangeType'''
| What type of information should be shown in craft articles for the fuel capacity/range? Possible options:
* -1 = Fuel capacity
* 0 = Maximum theoretical range
* 1 = Minimum and maximum theoretical max range
* 2 = Average theoretical max range
| -1
|- style="background-color:#ddffdd;"
| '''hidePediaInfoButton'''
| Show the INFO button (where applicable) or not?
| false
|- style="background-color:#ddffdd;"
| '''extraNerdyPediaInfoType'''
| Display extra item info (accuracy modifier and power bonus) in the main pedia article or not?

* 0 = don't display
* 1 = display with full names
* 2 = display with abbreviations
| 0
|}

==== Battlescape ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''alienFuel'''
| Name of an item representing alien fuel and a quantity to recover from a single fuel cell. Format: [name, quantity].
| [-, -]
|- style="background-color:#ddffdd;"
| '''baseDefenseMapFromLocation'''
| Whether or not to load additional base defense terrain from globe texture. 0 = no, 1 = yes.

More info: https://openxcom.org/forum/index.php/topic,5108.0.html
| 0
|- style="background-color:#ddffdd;"
| '''lighting'''
| Configuration of light propagation:
* '''enhanced''': flags to switch between vanilla and directional light propagation (1 = directional for tiles and fire, 2 = directional for items, 4 = directional for units); add the numbers together to turn on multiple flags (e.g. 1+2+4=7 = directional lighting for all light sources)
* '''maxStatic''': maximum range/radius for tile and fire light propagation
* '''maxDynamic''': maximum range/radius for item and unit light propagation

Defaults:

  lighting:
    enhanced: 0
    maxStatic: 16   #Careful, affects overall game performance!
    maxDynamic: 24  #Careful, affects overall game performance!

| <=
|- style="background-color:#ddffdd;"
| '''maxViewDistance'''
| Maximum view distance (in tiles). If you want to use bigger/custom view distances (in general, or per armor), you need to set this variable to the maximum of all view distances you're using.

'''VERY IMPORTANT''': Although optimized (in OXCE) a lot compared to OpenXcom, this setting still has huge impact on game performance! The performance decrease is exponential, i.e. changing value from 20 to 40 doesn't decrease the performance only by a factor of 2, but much much more. Recommended maximum value is up to 30. If you're willing to sacrifice game performance you can go up to 40. Above 40, it's unplayable.
| 20
|- style="background-color:#ddffdd;"
| '''maxDarknessToSeeUnits'''
| The threshold of shade/darkness for LoS calculation. Shade ranges (for value set to 9):
* 0 = no shade: Daylight, full visibility.
* 1-9 = partial shade: Dusk/Dawn, also full visibility.
* 10-15 = full shade: Night, decreased visibility for XCOM.
| 9
|- style="background-color:#ddffdd;"
| '''explodeInventoryGlobal'''
| A global default value for item attribute '''explodeInventory'''. Can be overridden per item.

* 0 = doesn't explode in inventory (default, vanilla)
* 1 = explodes in inventory, except in hands
* 2 = explodes in inventory
| 0
|- style="background-color:#ddffdd;"
| '''noLOSAccuracyPenaltyGlobal'''
| A global default value for accuracy penalty (in percent), when shooting at a unit or tile outside of LoS (line of sight). Can be overridden per weapon.
| -1
|- style="background-color:#ddffdd;"
| '''kneelBonusGlobal'''
| A global default value for accuracy bonus, when kneeling. Can be overridden per weapon. 115 means 15% bonus (100+15).
| 115
|- style="background-color:#ddffdd;"
| '''oneHandedPenaltyGlobal'''
| A global default value for accuracy penalty, when using a two-handed weapon with just one hand. Can be overridden per weapon. 80 means 20% penalty (100-20).
| 80
|- style="background-color:#ddffdd;"
| '''enableCloseQuartersCombat'''
| Whether or not CQC (close quarters combat) feature should be enabled. 0 = no, 1 = yes.
| 0
|- style="background-color:#ddffdd;"
| '''closeQuartersAccuracyGlobal'''
| A global default "accuracy" value for CQC check. Can be overridden per weapon.

'''FIXME''': add a full example of CQC check, with all variables included.
| 100
|- style="background-color:#ddffdd;"
| '''closeQuartersTuCostGlobal'''
| Amount of time units the target unit (victim) needs to have to be able to perform CQC. If CQC is triggered, TUs will be also spent. If CQC is not triggered, TUs will '''not''' be spent.
| 12
|- style="background-color:#ddffdd;"
| '''closeQuartersEnergyCostGlobal'''
| Amount of energy the target unit (victim) needs to have to be able to perform CQC. If CQC is triggered, energy will be also spent. If CQC is not triggered, energy will '''not''' be spent.
| 8
|- style="background-color:#ddffdd;"
| '''closeQuartersSneakUpGlobal'''
| Percentage chance of avoiding CQC when sneaking up on an enemy.

Alien attacker can avoid CQC when xcom victim doesn't see the alien attacker. Xcom attacker can avoid CQC when all aliens (as a collective) were not aware of the xcom attacker during the previous and the current turn.
| 0
|- style="background-color:#ddffdd;"
| '''tooMuchSmokeThreshold'''
| A technical parameter, which you may want to change if you want to be able to (always) extinguish fire from map tiles using smoke.

More info: https://openxcom.org/forum/index.php/topic,4057.msg59352.html#msg59352
| 10
|- style="background-color:#ddffdd;"
| '''hiddenMovementBackgrounds'''
| A list of sprites for "Hidden Movement" backgrounds. Chosen randomly at the beginning of a mission. Purely cosmetic.
| -
|- style="background-color:#ddffdd;"
| '''showFullNameInAlienInventory'''
| A global default value for showing unit name (true) or unit race (false) in the [Alien Inventory] screen. Can be overridden per unit type.
| false
|- style="background-color:#ddffdd;"
| '''destroyedFacility'''
| A global default value defining a special "rubble" facility that remains after a normal facility is destroyed (during base defense or via alien missile attacks/bombardment). Must have size 1. Can be overridden per facility type.
| -
|- style="background-color:#ddffdd;"
| '''giveScoreAlsoForResearchedArtifacts'''
| Whether the game awards score (in Debriefing) also for researched alien artifacts (true) or only for not yet researched artifacts (false).
| false
|- style="background-color:#ddffdd;"
| '''missionRatings'''
| A list of mission ratings. Each item contains a minimum required mission score and a corresponding String ID of the rating. Example:

  missionRatings:
    2000: STR_MS_RATING_HOLY_COW
    1000: STR_MS_RATING_AMAZING
    750: STR_MS_RATING_PERFECT
    500: STR_MS_RATING_VERY_GOOD
    350: STR_MS_RATING_GOOD
    150: STR_MS_RATING_OK
    0: STR_MS_RATING_MEH
    -200: STR_MS_RATING_BAD
    -350: STR_MS_RATING_WORSE
    -500: STR_MS_RATING_TERRIBLE
    -1000: STR_MS_RATING_DISASTER
    -99999: STR_MS_RATING_EPIC_FAIL

| -
|- style="background-color:#ddffdd;"
| '''statisticalBulletConservation'''
| If enabled, there's a chance to recover a full clip depending on how much ammo has remained.
| false
|- style="background-color:#ddffdd;"
| '''stunningImprovesMorale'''
| If enabled, stunning enemies improves morale in a similar way killing an enemy does.

More info: https://openxcom.org/forum/index.php/topic,7439.0.html
| false
|- style="background-color:#ddffdd;"
| '''tuRecoveryWakeUpNewTurn'''
| Percentage of max TU that should be given to a unit that wakes up from unconsciousness at a beginning of a new turn.
| 100
|}

==== Mana ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''mana'''
| Global switches to turn mana GUI and features on/off.

More info: https://openxcom.org/forum/index.php/topic,7241.0.html

Example:

  mana:
    enabled: false
    battleUI: false
    unlockResearch: STR_SORCERY     # empty by default
    trainingPrimary: false
    trainingSecondary: false
    woundThreshold: 200             # default is 200
    replenishAfterMission: true

| see example
|- style="background-color:#ddffdd;"
| '''health'''
| Health recovery modding options. Allows soldiers to go into battle even with missing health.

More info: https://openxcom.org/forum/index.php/topic,8020.0.html

Example:

  health:
    woundThreshold: 100             # default is 100
    replenishAfterMission: true

| see example
|}

==== AI ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="color:#666666;"
| '''minReactionAccuracy'''
| ''Deprecated:'' use '''reactionFireThreshold''' and '''reactionFireThresholdCiv''' instead.
| -
|- style="background-color:#ddffdd;"
| '''ai.reactionFireThreshold'''
| AI-controlled hostile units will not reaction fire, if their accuracy (for a given target) is below this threshold.

Used to prevent AI making shots that are unlikely to hit, which only makes them waste ammo and TUs. Instead they could wait until the target comes closer or shoot at another target.
| 0
|- style="background-color:#ddffdd;"
| '''ai.reactionFireThresholdCiv'''
| AI-controlled neutral units will not reaction fire, if their accuracy (for a given target) is below this threshold.
| 0
|-
| '''turnAIUseGrenade'''
| Defines a turn, from which the aliens are allowed to use grenades.
| 3
|-
| '''turnAIUseBlaster'''
| OXC: Defines a turn, from which the aliens are allowed to use any AoE weapons (blaster launcher, small launcher, etc.).
<span style="background:#ddffdd;">OXCE: Defines a turn, from which the aliens are allowed to use waypoint-based weapons.</span>
| 3
|- style="background-color:#ddffdd;"
| '''ai.useDelayBlaster'''
| Alias for '''turnAIUseBlaster'''.
| 3
|- style="background-color:#ddffdd;"
| '''ai.useDelayFirearm'''
| Defines a turn, from which the aliens are allowed to use firearms.
| 0
|- style="background-color:#ddffdd;"
| '''ai.useDelayGrenade'''
| Alias for '''turnAIUseGrenade'''.
| 3
|- style="background-color:#ddffdd;"
| '''ai.aiUseDelayProxy'''
| Defines a turn, from which the aliens are allowed to use proxy grenades.
| 999
|- style="background-color:#ddffdd;"
| '''ai.useDelayMedikit'''
| Defines a turn, from which the aliens are allowed to use medikits.
| 999
|- style="background-color:#ddffdd;"
| '''ai.useDelayMelee'''
| Defines a turn, from which the aliens are allowed to use melee weapons.
| 0
|- style="background-color:#ddffdd;"
| '''ai.useDelayPsionic'''
| Defines a turn, from which the aliens are allowed to use psi amps.

Example:

  ai:
    useDelayBlaster: 3
    useDelayFirearm: 1
    useDelayGrenade: 1
    useDelayMelee: 1
    useDelayPsionic: 2

| 0
|- style="background-color:#ddffdd;"
| '''ai.fireChoiceIntelCoeff'''<br/>'''ai.fireChoiceAggroCoeff'''
| More info here: https://openxcom.org/forum/index.php/topic,5679.0.html
| 5<br/>5
|- style="background-color:#ddffdd;"
| '''ai.extendedFireModeChoice'''<br/>'''ai.respectMaxRange'''
| More info here: https://openxcom.org/forum/index.php/topic,5980.0.html
| false<br/>false
|- style="background-color:#ddffdd;"
| '''ai.destroyBaseFacilities'''
| More info here: https://openxcom.org/forum/index.php/topic,6663.0.html
| false
|- style="background-color:#ddffdd;"
| '''ai.pickUpWeaponsMoreActively'''<br/>'''ai.pickUpWeaponsMoreActivelyCiv'''
| More info here: https://openxcom.org/forum/index.php/topic,6882.0.html
| false<br/>false
|- style="background-color:#ddffdd;"
| '''ai.targetWeightThreatThreshold'''<br/>'''ai.targetWeightAsHostile'''<br/>'''ai.targetWeightAsHostileCivilians'''<br/>'''ai.targetWeightAsFriendly'''<br/>'''ai.targetWeightAsNeutral'''
| More info: https://openxcom.org/forum/index.php?topic=6586.msg171202#msg171202

  ai:
    targetWeightThreatThreshold: 50
    targetWeightAsHostile: 100
    targetWeightAsHostileCivilians: 50
    targetWeightAsFriendly: -200
    targetWeightAsNeutral: -100

| 50<br/>100<br/>50<br/>-200<br/>-100
|}

===== Surrendering, Bughunt =====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''surrenderMode'''
| Allows enemies to surrender (they will be taken as prisoners). Possible options:
* 0 = no surrender
* 1 = if all remaining standing enemies can surrender; and they want to surrender at this very moment (their current status is panicking or berserking)... end the battle
* 2 = if all remaining standing enemies can surrender; and they have panicked/berserked at least once or have been stunned at least once... end the battle
* 3 = same as option 2, but enemies must also have empty hands

In all 3 cases, enemies marked as "auto surrender" are not checked and count as surrendered.
| 0
|- style="background-color:#ddffdd;"
| '''bughuntMinTurn'''
| Earliest turn on which the "bughunt mode" can be activated. Once activated, it won't be turned off (except on multi-stage missions). During bughunt mode, you can see all remaining enemies on the minimap.
| 999
|- style="background-color:#ddffdd;"
| '''bughuntMaxEnemies'''
| Maximum amount of active enemies for bughunt mode to trigger.
| 2
|- style="background-color:#ddffdd;"
| '''bughuntRank'''
| If VIPs are still active, bughunt won't trigger. Possible options:
* -1 = no VIPs
* 0 = aliens with rank 0 are VIPs
* 1 = aliens with rank 0 and 1 are VIPs
* 2 = aliens with rank 0, 1 and 2 are VIPs
* and so on...
| 0
|- style="background-color:#ddffdd;"
| '''bughuntLowMorale'''
| Defines a threshold for "low morale".
| 40
|- style="background-color:#ddffdd;"
| '''bughuntTimeUnitsLeft'''
| Defines a threshold for "too much TUs". Threshold is configured as percentage of max. TUs.

If a unit doesn't have any weapon (in both hands) or if a unit has "low morale" or if a unit has "too much TUs" (i.e. cannot/doesn't move for whatever reason)... it counts as powerless and bug hunt can be activated.

If there is still a unit that is not powerless, bug hunt won't be activated.
| 60
|}

==== Difficulty Settings ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''startingDifficulty'''
| Pre-selected difficulty when starting a new game. Possible options:
* 0 = beginner
* 1 = experienced
* 2 = veteran
* 3 = genius
* 4 = superhuman
| 0
|-
| '''difficultyDemigod'''
| If enabled, enemies will spawn even if the map doesn't have enough spawn points to spawn them all. Will spawn max number of additional units defined by '''dQty''' and '''extraQty''' in ''Deployment Data''.

Note: affects all difficulty levels, not just Superhuman difficulty.

<span style="background:#ddffdd;">OXCE: number of additional units in reinforcement waves for '''dQty''' and '''extraQty''' is still random.</span>
| false
|-
| '''difficultyCoefficient'''
| Difficulty coefficients (per 5 game difficulty levels) affecting various game mechanics, for example:
* Monthly rating threshold for losing the game (together with '''defeatScore''') | (defeatScore) +100 points * difficultyCoefficient
* UFO firing rate during dogfight | -2 gs * difficultyCoefficient
* UFO escape countdown during dogfight | (100-200%) -30 gs * difficultyCoefficient
* Retaliation odds after shooting down UFO | (4%) +4% * difficultyCoefficient
* Odds of shootdown-triggered retaliation targeting xcom base region or not | (50%) +6% * difficultyCoefficient
* Chance of aliens facing in the direction of the xcom craft at a start of a mission | 20% * difficultyCoefficient
* Various AI decisions (in Battlescape)
** judging explosive efficacy
** limiting number of waypoints for blasters
** deciding whether to spend extra TU to attack from behind in melee (OXCE only)
** odds of making USE action on psi-amps (OXCE only)
* Together with '''statGrowthMultipliers''' affects how alien stats change with difficulty level | + (statGrowthMultipliers/100) * difficultyCoefficient
* Does not affect aimAndArmorMultipliers, aimMultipliers and armorMultipliers.
* OXCE: Does not affect statGrowthMultipliersAbs and armorMultipliersAbs.
| [0, 1, 2, 3, 4]
|- style="background-color:#ddffdd;"
| '''difficultyCoefficientOverrides'''
| Ability to override '''difficultyCoefficient''' effects:
* Monthly rating threshold for losing the game | directly specified value per difficulty
* UFO firing rate during dogfight | percentual multiplier per difficulty
* UFO escape countdown during dogfight | percentual multiplier per difficulty
* Retaliation odds after shooting down UFO | directly specified percentage value per difficulty
* Odds of shootdown-triggered retaliation targeting xcom base region or not | directly specified percentage value per difficulty
* Chance of aliens facing in the direction of the xcom craft at a start of a mission | directly specified percentage value per difficulty

Example (with some vanilla values):

 difficultyCoefficientOverrides:
   monthlyRatingThresholds: [-900, -800, -700, -600, -500]   # vanilla points; please note that only NEGATIVE numbers are accepted here
   ufoFiringRateCoefficients: [100, 95, 90, 85, 80]          # percent of default... percentages instead of vanilla flat values
   ufoEscapeCountdownCoefficients: [100, 95, 90, 85, 80]     # percent of default... percentages instead of vanilla flat values
   retaliationTriggerOdds: [4, 8, 12, 16, 20]                # vanilla percentages
   retaliationBaseRegionOdds: [50, 56, 62, 68, 74]           # vanilla percentages
   aliensFacingCraftOdds: [0, 20, 40, 60, 80]                # vanilla percentages

| -
|- style="background-color:#ddffdd;"
| '''difficultyBasedRetaliationDelay'''
| Defines a delay (in months, per difficulty level) for spawning retaliation missions after dogfights. If the campaign is still in the "protected period", retaliation missions won't spawn. This can be used to prevent unlucky base defense missions in early game for beginners.

Note: does not affect regularly spawned retaliation missions (via monthly mission script), nor alien base gen/hunt missions.
| [0, 0, 0, 0, 0]
|-
| '''aimAndArmorMultipliers'''
| Affects armor values and firing accuracy of aliens for different difficulty levels.
| [0.5, 1.0, 1.0, 1.0, 1.0]
|- style="background-color:#ddffdd;"
| '''aimMultipliers'''
| Affects firing accuracy of aliens for different difficulty levels.
| [0.5, 1.0, 1.0, 1.0, 1.0]
|- style="background-color:#ddffdd;"
| '''armorMultipliers'''
| Affects armor values of aliens for different difficulty levels.
| [0.5, 1.0, 1.0, 1.0, 1.0]
|- style="background-color:#ddffdd;"
| '''armorMultipliersAbs'''
| Affects armor values of aliens for different difficulty levels. These are absolute values, not percentages.
| [0, 0, 0, 0, 0]
|-
| '''statGrowthMultipliers'''
| Affects unit stats of aliens for different difficulty levels.
| -
|- style="background-color:#ddffdd;"
| '''statGrowthMultipliersAbs'''
| Affects unit stats of aliens for different difficulty levels. These are absolute values, not percentages.

More info: https://openxcom.org/forum/index.php/topic,11462.0.html
| -
|-
| '''defeatScore'''
| Monthly score threshold for losing the game on Beginner difficulty. Other difficulties have different thresholds, affected by '''difficultyCoefficient'''.
| 0
|-
| '''defeatFunds'''
| Debt threshold (at a start of a month) for losing the game, on all difficulty levels.
| 0
|- style="background-color:#ddffdd;"
| '''sellPriceCoefficient'''
| Affects global sell prices. Defined in percent per difficulty level. Example:

  sellPriceCoefficient: [150, 100, 80, 60, 40]

| -
|- style="background-color:#ddffdd;"
| '''buyPriceCoefficient'''
| Affects global buy prices. Defined in percent per difficulty level. Example:

  buyPriceCoefficient: [40, 60, 80, 100, 150]

| -
|}

==== Other Constants ====

These are constants that were needed to support TFTD in OpenXcom. You are most likely never going to need to modify them, but we list them here for completeness sake. They are defined as an associative array of values (a list of values syntax is deprecated) under the ''constants:'' entry.

Some of these constants can be considered as difficulty settings, and vanilla ruleset defines them in ''difficulty.rul''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''damageRange'''
| Defines the damage range for projectile weapons. 100 means 0-200% range, 50 means 50-150% range, 25 means 75-125% range, etc.
| 100
|-
| '''explosiveDamageRange'''
| Defines the damage range for AOE weapons (e.g. explosives).
| 50
|-
| '''fireDamageRange'''
| Defines the damage range for incendiary weapons. Format is: [min, max].
| [5, 10]
|}

These constants can be especially interesting for hybrid mods (UFO/TFTD hybrids).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''explosionOffset'''
| Explosion offset in X1.PCK

Note: this defines the land explosion offset. Underwater explosion offset is smaller by 8. For example, if you define land offset to be 24, underwater offset will be automatically set to 16.
| 0
|-
| '''smokeOffset'''
| Surface smoke animation offset in SMOKE.PCK
| 8
|-
| '''underwaterSmokeOffset'''
| Underwater smoke animation offset in SMOKE.PCK
| 0
|}

<div style="background:#ddffdd;">And there are a few OXCE-only constants, that were put into this section for technical reasons.
</div>

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|- style="background-color:#ddffdd;"
| '''extendedItemReloadCost'''
| If set to true, the item reload cost equals to "cost of moving ammo to hand" + "cost of reload".
| false
|- style="background-color:#ddffdd;"
| '''extendedInventorySlotSorting'''
| Allows to choose between algorithm (B3) and (A2). For details see: https://openxcom.org/forum/index.php?topic=7868.msg161833#msg161833
| false
|- style="background-color:#ddffdd;"
| '''extendedMovementCostRounding'''
| Option to configure movement cost calculation rounding.
* 0 = OXCE Floor (default) -- most similar to OXC, but not perfect, more info here: https://openxcom.org/forum/index.php?topic=11930.msg163392#msg163392
* 1 = OXCE Round (0.5 up)
* 2 = OXCE Round (0.5 down)
| 0
|- style="background-color:#ddffdd;"
| '''extendedRunningCost'''
| If set to true, running soldiers will ignore mutual surprise (i.e. will not stop running when spotting a new enemy).
| false
|- style="background-color:#ddffdd;"
| '''extendedHwpLoadOrder'''
| If set to true, craft load order is: 2x2 HWPs, 2x2 soldiers, 1x1 HWPs, 1x1 soldiers.
If false, load order is: all HWPs, all soldiers.
| false
|- style="background-color:#ddffdd;"
| '''extendedSpotOnHitForSniping'''
| Configures spotting for snipers.
* 0 = no spotting on hit (this is the new default)
* 1 = spotting only if the hit unit doesn't die or fall unconscious
* 2 = always spotting on hit (this was the original default)

More info: https://openxcom.org/forum/index.php?topic=12278.0
| 0
|- style="background-color:#ddffdd;"
| '''extendedBerserkWithAimed'''
| Enables berserking with aimed shots. More info: https://openxcom.org/forum/index.php?msg=173924
* 0 = vanilla, no aimed shots (default)
* 1 = only BA_AIMEDSHOT
* 2 = both BA_AIMEDSHOT and BA_LAUNCH
| 0
|- style="background-color:#ddffdd;"
| '''extendedMeleeReactions'''
| Enables reactions to melee attacks.
* 0 = vanilla, cannot react to melee attacks
* 1 = can react to melee attacks, if attacked from the front
* 2 = can react to melee attacks, if attacked from any side
| 0
|- style="background-color:#ddffdd;"
| '''extendedTerrainMelee'''
| Allows melee weapons to destroy terrain.
* 0 = vanilla, turned off
* 1 to 11 = turned on (higher number means that it only applies to taller objects/walls)

More info: https://openxcom.org/forum/index.php/topic,8634.0.html
| 0
|- style="background-color:#ddffdd;"
| '''extendedUnderwaterThrowFactor'''
| Allows globally changing underwater throwing range.
* 0 = vanilla, turned off
* 1+ = turned on, e.g. 60 means underwater throwing range equals to 60% of the surface throwing range

More info: https://openxcom.org/forum/index.php/topic,8273.msg132698.html#msg132698
| 0
|- style="background-color:#ddffdd;"
| '''extendedExperienceAwardSystem'''
| Allows to switch between OXC and OXCE experience award system.
* false = use OXC system
* true = use OXCE system

More info: https://openxcom.org/forum/index.php/topic,4230.msg154823.html#msg154823
| true
|- style="background-color:#ddffdd;"
| '''extendedForceSpawn'''
| Force alien spawning even if there are no more spawn nodes left? (remaining aliens will spawn next to already spawned aliens)

More info here: https://openxcom.org/forum/index.php?topic=12504.0
| false
|- style="background-color:#ddffdd;"
| '''extendedCurrencySymbol'''
| Allows to override the game's currency symbol.

More info here: https://openxcom.org/forum/index.php?topic=12216.0
| $
|- style="background-color:#ddffdd;"
| '''extendedPediaFacilityParams'''
| Parameters used for ufopedia facility preview display. More info: https://openxcom.org/forum/index.php?topic=11819.msg161957#msg161957
| [2,2,0,0]
|}

The rest is defined in ''vars.rul'' (for TFTD), or left untouched at default values (for UFO:EU).

{| class="wikitable" width="100%"
! width="150"| Value
! width="*"  | Description
! width="80" | Default
|-
| '''doorSound'''
| Sound of normal doors opening.
| 3
|-
| '''slidingDoorSound'''
| Sound of sliding doors opening.
| 20
|-
| '''slidingDoorClose'''
| Sound of sliding doors closing.
| 21
|-
| '''smallExplosion'''
| Sound of a small explosion (power <= 80).
| 2
|-
| '''largeExplosion'''
| Sound of a large explosion (power > 80).
| 5
|-
| '''itemDrop'''
| Sound of item dropping (in the inventory).
| 38
|-
| '''itemThrow'''
| Sound of item being thrown.
| 39
|-
| '''itemReload'''
| Reload sound.
| 17
|-
| '''walkOffset'''
| Offset for various footstep sounds.
| 22
|-
| '''flyingSound'''
| Sound of a unit flying.
| 15
|-
| '''buttonPress'''
| Sound played when a button is pressed.
| 0
|-
| '''windowPopup'''
| Sounds played (one chosen randomly) when a window pops up.
| [1, 2, 3]
|-
| '''ufoFire'''
| Sound of a UFO firing.
| 8
|-
| '''ufoHit'''
| Sound of a UFO being hit.
| 12
|-
| '''ufoCrash'''
| Sound of a UFO crashing.
| 10
|-
| '''ufoExplode'''
| Sound of a UFO being destroyed.
| 11
|-
| '''interceptorHit'''
| Sound of an XCOM interceptor being hit.
| 10
|-
| '''interceptorExplode'''
| Sound of an XCOM interceptor being destroyed.
| 13
|-
| '''geoscapeCursor'''
| Palette offset for a cursor when using PAL_GEOSCAPE palette.
| 252
|-
| '''basescapeCursor'''
| Palette offset for a cursor when using PAL_BASESCAPE palette.
| 252
|-
| '''battlescapeCursor'''
| Palette offset for a cursor when using PAL_BATTLESCAPE* palettes.
| 144
|-
| '''ufopaediaCursor'''
| Palette offset for a cursor when using PAL_UFOPAEDIA palette.
| 252
|-
| '''graphsCursor'''
| Palette offset for a cursor when using PAL_GRAPHS palette.
| 252
|-
| '''goodDebriefingMusic'''
| Music played in the Debriefing when the score is positive.
| GMMARS
|-
| '''badDebriefingMusic'''
| Music played in the Debriefing when the score is zero or negative.
| GMMARS
|}

=== Recommended/Fixed User Options ===

<div style="background:#ddffdd;">
OpenXcom offers various settings in the [Options > Advanced] screen.

Some of these settings however are actually not user settings, but rather mod settings. Or in other words, some settings are either not compatible with some mods or change the mod balance in an unacceptable way. Therefore, OXCE gives modders the option to fix these settings. i.e. set them to a desired value and not allow users to change them.

All these fixed options are listed in ''"fixedUserOptions:"''. For example:

  fixedUserOptions:
    battleUFOExtenderAccuracy: true
    battleInstantGrenade: false
    allowPsiStrengthImprovement: false

Since OXCE v6.5.1, there is also a possibility to only recommend some settings... meaning the settings will be changed only once by a mod (when activated) and the user will still be able to change the settings manually.

All these recommended options are listed in ''"recommendedUserOptions:"''. For example:

  recommendedUserOptions:
    oxceNightVisionColor: 2
    oxceManufactureScrollSpeed: 5
    oxceManufactureScrollSpeedWithCtrl: 1
    oxceResearchScrollSpeed: 1
    oxceResearchScrollSpeedWithCtrl: 5

Below is a list of possible options to fix, their default English names and possible values, grouped by category.
* There are more options (than listed below) in each category, but they are real user settings, so we don't list them here.
* The codes are the same as used in ''options.cfg'' configuration file.
</div>

==== General ====

{| class="wikitable" width="100%"
! width="200"| Code
! width="*"  | Name
! width="200" | Possible values
|- style="background-color:#ddffdd;"
| '''playIntro'''
| Play intro; this is normally a user option. A modder working on a total conversion mod may want to disable it though.
| true/false
|}

==== Geoscape ====

{| class="wikitable" width="100%"
! width="200"| Code
! width="*"  | Name
! width="200" | Possible values
|- style="background-color:#ddffdd;"
| '''aggressiveRetaliation'''
| Aggressive retaliation
| true/false
|- style="background-color:#ddffdd;"
| '''customInitialBase'''
| Custom initial base
| true/false
|- style="background-color:#ddffdd;"
| '''allowBuildingQueue'''
| Allow building queue; this is normally a user option.
| true/false
|- style="background-color:#ddffdd;"
| '''craftLaunchAlways'''
| Force craft launch
| true/false
|- style="background-color:#ddffdd;"
| '''storageLimitsEnforced'''
| Storage limits for recovered items
| true/false
|- style="background-color:#ddffdd;"
| '''canSellLiveAliens'''
| Live alien sale
| true/false
|- style="background-color:#ddffdd;"
| '''anytimePsiTraining'''
| Psionic training at any time
| true/false
|- style="background-color:#ddffdd;"
| '''psiStrengthEval'''
| Psi-Strength Evaluation
| true/false
|- style="background-color:#ddffdd;"
| '''canTransferCraftsWhileAirborne'''
| Airborne transfers
| true/false
|- style="background-color:#ddffdd;"
| '''retainCorpses'''
| Retain interrogated aliens
| true/false
|- style="background-color:#ddffdd;"
| '''fieldPromotions'''
| Field promotions; this is normally a user option.
| true/false
|}

==== Battlescape ====

{| class="wikitable" width="100%"
! width="200"| Code
! width="*"  | Name
! width="200" | Possible values
|- style="background-color:#ddffdd;"
| '''sneakyAI'''
| Sneaky AI
| true/false
|- style="background-color:#ddffdd;"
| '''battleUFOExtenderAccuracy'''
| UFO Extender accuracy
| true/false
|- style="background-color:#ddffdd;"
| '''battleInstantGrenade'''
| Instant grenades
| true/false
|- style="background-color:#ddffdd;"
| '''includePrimeStateInSavedLayout'''
| Save pre-primed grenades
| true/false
|- style="background-color:#ddffdd;"
| '''battleExplosionHeight'''
| Explosion height
| 0-3
|- style="background-color:#ddffdd;"
| '''weaponSelfDestruction'''
| Alien weapon self-destruction
| true/false
|- style="background-color:#ddffdd;"
| '''allowPsionicCapture'''
| Allow psi-capture
| true/false
|- style="background-color:#ddffdd;"
| '''allowPsiStrengthImprovement'''
| Allow Psi-Strength Improvement
| true/false
|- style="background-color:#ddffdd;"
| '''strafe'''
| Alternate movement methods
| true/false
|- style="background-color:#ddffdd;"
| '''noAlienPanicMessages'''
| Suppress panic messages for aliens
| true/false
|- style="background-color:#ddffdd;"
| '''alienBleeding'''
| Alien bleeding
| true/false
|}

==== Extended ====

{| class="wikitable" width="100%"
! width="200"| Code
! width="*"  | Name
! width="200" | Possible values
|- style="background-color:#ddffdd;"
| '''oxceStartUpTextMode'''
| Allows to modify the text that is displayed during the game start up. Possible options:
* 0 = vanilla (default)
* 1 = remove dos4gw and soundblaster text
* 2 = remove all text
| 0-2
|- style="background-color:#ddffdd;"
| '''oxceWoundedDefendBaseIf'''
| Wounded soldiers defend the base too, if their health is above the given percentage threshold.
| 0-100
|}

=== Scripts ===

<div style="background:#ddffdd;">
OXCE offers the ability to use a custom '''scripting language''' to modify game logic on certain places via script hooks.

Scripts that change game graphics are run every frame. Others like hitUnit are only run when the event itself happens.

Currently supported are ('''FIXME''' add short description to each hook):
* '''Unit scripts'''
** recolorUnitSprite: Runs for every pixel of a units graphic. Change to any color.
** selectUnitSprite: Runs for every part of a units graphic. E.g. Change the graphic used for legs.
** selectMoveSoundUnit: Runs for each unit step.
** reactionUnitAction: Runs when an unit performs an action that triggers reaction fire.
** reactionUnitReaction: Runs when a unit sees another unit perform an action that triggers reaction fire.
** hitUnit: When a unit is hit it allows adjusting damage and the part of the body it affects. Runs before damageUnit
** damageUnit: Used to alter the final change to stats of a unit when its hit by a weapon. If unit receives a hit with 0 power this script doesnt run. 
** healUnit: Used to alter effect of medikit on unit. Can alter exp from usage of it.
** createUnit: Runs when new unit is created
** newTurnUnit: Runs for every unit every turn (this includes alien, civilian and xcom turns)
** returnFromMissionUnit: Runs for every unit at the end of a mission.
** awardExperience: Runs whenever a unit performs an action that can earn it experience.
** [[VisibilityUnit_(OpenXcom)|visibilityUnit]]: Runs to check if two units of opposing factions can see each other.
* '''Item scripts'''
** recolorItemSprite: Runs for every pixel of sprite. Change color.
** selectItemSprite: Run to change the graphic of an item when its on the floor or in the hands of a soldier
** reactionWeaponAction: Runs for the weapon that triggered reaction shots by firing.
** createItem: Runs when a new item is created.
** newTurnItem: Runs for each item each turn. (this includes alien, civilian and xcom turns)
* '''Stat bonus scripts'''
** For armors: psiDefence, meleeDodge, recovery (time, energy, morale, health, stun, mana)
** For items: damageBonus, meleeBonus, accuracyMultiplier, meleeMultiplier, throwMultiplier, closeQuartersMultiplier
** For units: applySoldierBonuses: Runs once for each bonus of each soldier on mission start.
The syntax of the scripting language and a detailed description of the capabilities of each script hook is beyond the scope of this reference guide. For more information, see [[ModScript (OpenXcom)]].

If you're interested, please seek help on the OXCE forum: https://openxcom.org/forum/index.php/board,39.0.html
</div>

[[Category:OpenXcom]]