Ruleset Reference OXCE+ (OpenXcom)

A reference of all the customizable values of everything in a ruleset, according to OXCE+. This page should be updated as new versions become available in order to explain the additions to the Ruleset Reference.

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 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. You can find the default listOrders in Ruleset List Order.

Crafts

Defines one of the X-COM crafts that go on interception missions, listed in "crafts:".

Value	Description	Default
allowAlienBaseDetection	Determines whether this craft can detect alien bases on Geoscape	true

UFOs

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

Value	Description	Default
hunterKillerPercentage	100 = always created as HK (hunts XCom craft)	0
huntMode	0 (default) = prefer interceptors, 1 = prefer transports, 2 = random (generated at spawn)	0
huntSpeed	0 = mantain current speed, 100 = max speed, 100+ = also possible	-
huntBehavior	Only applies to HKs, not to normal UFOs (see notes at end for more details)	2

huntMode

When hunting interceptors:

• allowLanding: false is preferred
• craft without soldiers is preferred
• the less pilots onboard, the more attractive
• the less damaged craft, the more attractive (just to allow damaged craft to escape easier when fighting more HKs)

When hunting transports:

• allowLanding: true is preferred
• the more soldiers onboard, the more attractive

huntBehavior

• 0 = flee if losing (i.e. if ufo damage is more than 33% (=effective 66%) and craft damage is less than 50%)
• 1 = never flee, when damage reaches 50% (=effective 100%), self-destruct instead of crashing
• 2 = (default) randomly choose 0 or 1 at spawn

If huntBehaviour is used instead on alienMissions, ufo waves section:

• -1 = (default) use UFO's setting
• 0,1,2 = override UFOs setting with this new setting