CfgWeapons Config Reference

Introduction

cfgAmmo, cfgMagazines, cfgWeapons and cfgVehicles are root classes defined in the engine's config.bin.

These classes can be subsequently added to by addons inherit in the game or provided by oem.

cfgAmmo defines the missile characteristics for ammunition held in a cfgMagazine which, in turn, is used by a cfgWeapon, which, in turn, is selected for use in a (series of) cfgVehicles.

The same ammunition can be, and generally is, used by multiple magazines. The same magazine, can be, and generally is, used by multiple weapons. And so on.

cfgWepaons define the rifle e.g. characteristics. What muzzles it has, how many 'modes' (if any) it can use. What magazines are selectable.

Arma Enhancement

Arma introduced a new root class, cfgMagazines.

In contrast, OFP uses a rather tedious construct in it's cfgWeapons class to distinguish between weapon and magazine parameters.

The major alterations here are:

OFP	Arma
ammo=	moved to cfgMagazines
cost=	moved to cfgMagazines
displayNameMagazine=	moved to cfgMagazines and renamed DisplayName (of course)
magazines[] = {"this"};	magazines[] = {};
magazineType=	moved to cfgMagazines and renamed Type
maxLeadSpeed=	moved to cfgMagazines
minRange=	moved FROM cfgAmmo
minRangeProbab=
midRange=
midRangeProbab=
maxRange=
maxRangeProbab=
scopeWeapon=	renamed scope
scopeMagazine=	moved to cfgMagazines and renamed scope
shortNameMagazine=	moved to cfgMagazines and renamed descriptionShort?

Modifications

cfgWeapons {
    access = 1;
    ...

    //Weapon classes can be added.

    default {
        access = 3;
	}
	...
}

Existing classes can (rarely) be altered.

The default class of cfgWeapons specifies access = 3;. Almost all subsequent classes inherit this value, which means they cannot be altered in any way.

To allow YOUR addon to subsequently modify YOUR weapon (should you wish to with other addons), you must change the access= in YOUR Weapon.

Navigation: The the wood for the trees

cfgWeapons can be a puzzling mess to the uninitiated.

The tokenpairs, their placement, and their constructs can be befuddled. This is not a reflection on BI, the ultimate class structure is very, very, adaptive, but, it does confuse.

Essentially, Arma did open heart, and excellent, surgery to this class to distinguish between weapons and their magazines. OFP had a common weapon/magazine class with variables declaring what to use and when. Variables only relevant to OFP, are sometimes still encountered in Arma, simply because, they do no harm.

Weapons come in two major flavors (with plenty of sub themes). A weapon either has, or does not have, a modes[] class or classes adding different behaviour like autofire, burst or single shot. Confusingly, a weapon with only one mode, is, equivalent to not declaring it at all. The tokens that would normally be in a modes class, are declared in the main body instead. This obfuscates what-goes-where.

Weapons can have different muzzles, adding a further layer of modelling.

The inherited tree structure for weapons vs their magazines, vs their ammo, is not always logical. This is a throwback to OFP which (for instance) inherited RPG Ammo from an AT3, but inherited the RPG weapon from a CarlGustav, and so on. The end result being identical and good, since offending parameters were altered as necessary - but it does confuse what a HellfireHind really is, depending on who you are (ammo vs mag vs weapon).

Modes

Some TokenNames are relevant only within a mode class (e.g. sound[]=), and stated as such.

All weapons, without exception, have at least one mode class.

By default, the inherited mode for a weapon is:

modes[] = {"this"};

Which means the engine will treat the main body as also being a mode class unless over-ridden.

Some weapons do not have a modes class specified, nor do they inherit a specified modes class via their parent(s). Under these circumstances, TokenNames stated to be ModeClass only must occur in the main body of that weapon (or it's parents) instead. The TokenNames themselves, remain, accurately described, as being mode class only.

Muzzles

Exact same comments as per Modes. By default the inherited muzzle for a weapon is:

muzzles[] = {"this"};

Parameters belonging in muzzles are stated as such.

Different muzzles are normally only encountered on grenade launcher weapons (?).

TokenNames

All engines accept integer values (or math strings) where a float would normally be expected.

Default values are shown in the legend.

Usage

OFP: generally moved to Arma's cfgMagazines Class and often renamed, else simply renamed.

Arma: Introduced from OFP:E and beyond.

ModesClass: Any item marked as a ModeClass lives in a class Mode... body. It must be declared (or inherited) for each class.

MuzzleClass: Any item marked as a MuzzleClass lives in a class Muzzle... body. It must be declared (or inherited) for each class. Normally, except for grenade launchers, the muzzle IS the mainbody.

Blank: Used as described in both OFP, and, Arma.

Dual Use TokenNames (such as picture=) moved to Arma's cfgMagazines Class as appropriate.

Picture="[\][.pac]"

Defines WEAPON Picture and separately MAGAZINE Picture. OFP generally created two cfgWeapon classes. One for the weapon and one for the magazine. picture= was declared in each. In Arma, the magazine picture name has been moved to the cfgMagazines class as appropriate.

Note that this is one of those irritating BI path snafu's (when if ever will they start using relative addressing?). The following notes apply to most picture= references, not just cfgWeapons.

1. The DEFAULT extension is .pac. The engine accepts .pac or .paa, but .pac is not supposed to exist. A .paa must be explicitly declared.
2. Path must explicitly have a \ leading.

This because in OFP it was possible to not declare any picture at all.

In which case (in OFP) the engine looks for the .paa file in \dta\dtaext\NameOfClass.paa

The Arma engine appears to make a mess of it. Any picture reference without a preceding slash will look in a non-existent 'equip.pbo'

Specifically:

equip\w\w_your\path\name  // for weapons and
equip\m\m_your\path\name  // for mags

If no picture is specified, then like OFP, equip\w\w_NameOfClass is assumed.

Note also the 'convention' of naming weapon images with w_ and magazine images with m_ (and to a certain extent having data\equip file paths). This is rigidly followed in Arma. In OFP, BI were inconsistent.

Types

weaponType=WeaponHardMounted (OfpOnly)

Integers (Note this value is often held as a math String)

Gear (equipment) selection consists of SlotTypes and one or more slot positions of that type.

This integer is a bit-field containing SlotType and count which defines which SlotType this item will occupy in gear selection and how many slots of that type it requires. It does NOT define which slot position to occupy, only the Type of Slot. Various engines will show this item in positions of their own choosing.

An item is defined as being a weapon, magazine, or equipment.

• A weapon is rifle, handgun, LAW launcher.
• A magazine is a magazine, a shell ,a LAW, a PipeBomb, a grenade - i.e. a housing for the cfgAmmo explosive(s).
• equipment are binoculars, NVG, etc.

For Arma, MagazineSlots and WeaponSlots are mutually exclusive. The classes occur in the cfgWeapons or cfgMagazines respectively. In OFP both types of class exist in cfgWeapons, and are often the same class. OFP does not have a Type=; instead, it uses WeaponType= and MagazineType= couplets. The end result, and the intent, is identical.

⚠

Note: the quite serious alteration to SecondaryWeapon and Handgun mags that occurred in Arma. This to allow for an increased count field in Handgun Magazines.

Slot:	SlotType	value/nbits		Example
		OFP	Arma
Either:	NoSlot	0/0	same	stroke is a weapon, but it occupies no slots
Weapon:	PrimaryWeapon	1/1	same	AK47
Weapon:	HandGun	2/1	same	CZ75
Weapon:	SecondaryWeapon	16/1	4/1	LAW
Mag:	HandGunMagazines	32/3	16/4	CZ75Mag or GLMag
Mag:	MainMagazines	256/4	same	AK47Mag or explosives
Weapon:	BinocularSlot	4096/4	same	Binoculars or NVG, LD etc.
Weapon:	HardMounted	65536/1	same
Mag:	SmallItems		131072/4	(Arma 2) map, compass, small items (derived from ItemCore)

The specific combination for machine guns normally occupy both weapon slots i.e. PrimaryWeapon + SecondaryWeapon.

Magazine Sizes

Architecturally, all bit-fields are counts. The fact that a PrimaryWeapon can only be 1, still makes it a count of that SlotType.

In practical terms magazines are the only item (warning: currently) to have bit-fields > 1.

Most weapons use a single slot to declare a single magazine.

Shell weapons such as the RPG require three slots to hold the magazine. OFP presented this by filling those slots with the image. Arma makes a mess of it with a somewhat ugly blank between slots. You are supposed to guess why it's blank.

No handgun magazine (currently) has a size > 1. This could change on e.g. a remote controlled explosive. The bit-field is larger for reasons explained in Joining the dots (below).

For MainWeapon Magazines, specific bit-field identities between 256 and 4096 are frequently represented textually as:

"1 * 256" // main mags
"2 * 256" // m60,pk,mortars
"3 * 256" // law , rpg
"4 * 256" // 6g30 4 slots needed
"6 * 256" // carlgustav,stinger 6 slots needed
"8 * 256" // mm1 all slots needed

And, of course, in Arma, these fields are only relevant in it's CfgWeapons.

CfgVehicles: Joining the dots

A vehicle, in this case a human or parachute, has it's equipment slots defined in it's cfgVehicles Class. The Weaponslots= bit-field declares whether or not a piece of equipment can be carried at all, and if so, how much, or max size of that equipment, measured in slots.

cfgVehicles.Weaponslots= is deceptively similar to cfgWeapons.Type= (and vice versa). Weaponslots= defines the carrying capacity for equipment, type= defines the size of of that equipment.

Different humans have more or fewer slots than others. Clearly, medics, police, civilians and some resistance fighters, cannot carry heavy armament. They're either not trained to, or, they're already implicitly carrying medical packs. The disastrous Arma completely destroyed this distinction. Arma 2 enhances the distinction a little more than OFP.

A generalised capacity declaration for humans is:

weaponSlots=
	PrimaryWeapon+	Can carry a Primary Weapon
	SecondaryWeapon+	Sometimes able to carry a Secondary or even heavier Weapon (LAW, MG, stinger)
	(4+6)*MainMagazines+	Can carry n*Magazines for these weapons (AK47Mag) (or max size of shell)
	HandGun+	Can carry a Handgun (e.g. Beretta)
	2*WeaponSlotBinocular+	Can carry n*slots of equipment
	4*HandGunMagazines+	Can carry n*Handgun Magazines (CZ75Mag)
	12*SmallItems	can carry n*slots of SmallItems (Arma 2)

These will later be filled out with specific weapons in the human's weapons[]= and magazines[]= arrays. Placing too many causes a ctd^Clarify.

Note that specific Arma 2 women can only carry magazines and small equipment (for their boyfriends?) and nothing else.

Magazine carrying ability altered markedly for Arma 2 vs OFP; it's the reason for the nasty change to the bit-field, and is as follows:

		OFP	Arma
Rifle	Potential	15	15
	Actual	4 to 10	2 to 12
Handgun	Potential	7	15
	Actual	4	4 or 8
Binoculars		1 or 2	0 to 2

Alphabetical Order

A

access=3

Type

Integer

#define ReadAndWrite 0		// any modifications enabled
#define ReadAndCreate 1		// only adding new class members is allowed
#define ReadOnly 2			// no modifications enabled
#define ReadOnlyVerified 3	// no modifications enabled, CRC test applied

aiDispersionCoefX=1.0

Type

Float

Description

Dispersion multiplier for AI units (axis X - left to right).

aiDispersionCoefY=1.0

Type

Float

Description

Dispersion multiplier for AI units (axis Y - top-down).

aiRateOfFire=5.0

Class

ModeClass

Type

Float

Description

Delay between shots at given aiRateOfFireDistance.

aiRateOfFireDistance=500

Class

ModeClass

Type

Integer

Description

At shorter distance delay (aiRateOfFire) goes linearly to zero.

ammo=""

Class

OFPModeClass

Type

String

Description

cfgAmmo class that this weapon fires. Moved to cfgMagazines in Arma.

ammo = "TimeBomb";

autoAimEnabled=true

Type

Boolean

Description

false for all standard weapons.

autoFire=false

Class

ModeClass

Type

Boolean

Description

If true, weapon will fire repeatedly all the while you hold the fire button down.

And if true the gunner can use the weapon on his own discretion (no commander fire order needed - like MG type).

autoReload=true

Type

Boolean

Description

If true weapon will be reloaded automatically once magazine is empty.

B

backgroundReload=false

Type

Boolean

Description

Weapon automatically reloads magazines without player intervention or animation.

ballisticsComputer=false

Class

Arma

Type

Boolean

Description

Weapon attempts to calculate and shift the aim-point to hit a locked target based on range, target movement, own movement, and ballistics of selected ammo type.

burst=1

Class

ModeClass

Type

Integer

Description

Number of shots actually fired each time the weapon is fired.

C

cameraDir

Class

MuzzleClass

Type

String

cameraDir = "GL look";

canDrop=true

Type

Boolean

Description

Weapon can/not be dropped from Inventory Menu.

canDrop is poorly implemented. It is normally associated with true vehicles such as air. For humans nothing in the GUI panel suggests that you can't drop a weapon, and yet, hidden-from-view, the drop action has no effect. canDrop should have also been implemented in cfgMagazines, but isn't. You can always drop the magazine, and yet, for some weapons, such as a laser designator, this is nonsensical.

canLock=2

Type

Integer

Description

Defines if weapon can be locked on the target (white box appears).

#define LockNo		0
#define LockCadet	1
#define LockYes		2

cartridgePos="nabojnicestart"

Type

String

cartridgeVel="nabojniceend"

Type

String

count=0

Class

OFP

Type

Integer

Description

Number of shots weapon starts with. Moved to cfgMagazines in Arma.

cursor=""

Class

Arma

Type

String

cursor="w_weapon"

Class

OFP

Type

String

cursorAim=""

Class

Arma

Type

String

cursorAim = "\ca\Weapons\Data\cursor_target_locked_ca.paa";

cursorAim="w_lock"

Class

OFP

Type

String

cursorAimOn=""

Class

Arma

Type

String

cursorSize=1.0

Class

Arma

Type

Float

D

dexterity=3.1

Type

Float

Description

In-game weapon handling value, lower value = takes more time to traverse a weapon.

dexterity = 3.1;

dispersion=0.002

Class

ModeClass

Type

Float

Description

In-game weapon dispersion in radians. Bigger value = more dispersion.

displayName=""

Class

MainBody

Type

String

Description

Name of the WEAPON. Declared in the main body. This string is shown in gear selection as the rifle's name.

Class

ModeClass

Description

Name of the MODE. In every mode class. This string is shown in-game when selecting burst, single, auto etc.

A weapon that only has a single mode normally has the same displayname, repeated in the mode class. But, repeated, it must be.

A weapon with no modes (modes={"this"); uses the weapon name for both.

Class

MuzzleClass

Description

Name of the MUZZLE. In every muzzle class.

This string is shown in-game similar to burst, single, auto etc.

It is quite common for one of the muzzle classes to inherit a basic rifle muzzle, in which case, the name of the muzzle for THAT class is the inherited weapon name.

A weapon with no muzzles i.e. muzzles={"this"}; uses the weapon name.

displayNameMagazine=""

Class

OFP

Type

String

Description

displayname of the magazine in gear selection. Replaced in Arma via the cfgMagazines Class.

See also shortNameMagazine and descriptionShort

distanceZoomMax=400

Type

Integer

distanceZoomMin=400

Type

Integer

descriptionShort=""

Class

Arma

Type

String

Description

A paragraph or two describing the rifle in bottom left panel of in-game gear selection.

This is NOT equivalent of OFP's short label (shortNameMagazine). THAT descriptionShort exists in cfgMagazines.

drySound[]={"",1,1}

Type

Array

Description

Click Sound when empty weapon fired.

drySound[] = {"\ca\Weapons\Data\Sound\XMS_dry_v2", 0.000316228, 1};

E

enableAttack=true

Type

Boolean

emptySound[]={"",1,1}

Class

Arma

Type

Array

F

ffCount=1

Class

ModeClass

Type

Integer

ffFrequency=1

Class

ModeClass

Type

Float

ffMagnitude=0.0

Class

ModeClass

Type

Float

fireLightDuration=0.05

Class

Arma

Type

Float

fireLightIntensity=0.012

Class

Arma

Type

Float

flash=""

Type

String

flash = "gunfire";

flashSize=0.0

Class

ModeClass

Type

Float

Description

OFP only?

forceOptics=0

Type

Integer

Description

Valid values: 0, 1, 2 as per canLock.

H

handAnim[]={}

Class

Arma

Type

Array

I

initSpeed=0

Type

Integer

Description

Initial speed of shot in meters per second. Also present in cfgMagazines.

initSpeed = 900;

L

laser=false

Class

Arma

Type

Boolean

Library

Class

Arma

class Library
{
	libTextDesc = "";
};

libTextDesc

Class

ArmaClass

Type

String

libTextDesc = "$STR_LIB_SVD";

M

magazineReloadTime=0

Class

MuzzleClass

Type

Float

Description

Time delay when reloading the weapon (changing magazines).

magazines[]={"this"}

Class

OFP

Type

StringArray

Description

Array of magazine classes compatible with this weapon. This same Weapon class in cfgWeapons if not over-ridden.

magazines[]={}

Class

Arma

Type

StringArray

Description

These are declared here, same as OFP, but defined in cfgMagazines.

Note, with extreme caution: Unlike OFP, you cannot have identically named magazine classes. The in-game gear selection panel gets confused. Safe bet is to call all your magazine classes "[rifle]Mag".

maxLeadSpeed=50

Class

OFP

Type

Integer

Description

Maximum speed of the target that can be shot with this weapon by AI. Moved to cfgMagazines in Arma.

min/mid/maxRange...

Class

ArmaModeClass

Type

Integer

Description

Together with range and rangeProbab values, defines probability to use this weapon for AI units at given distance.

For OFP these parameters were specified in cfgAmmo, rendering all rifles the same.

magazineType=0

Class

OFP

Type

Integer

Description

See Types below.

minRange=1

Type

Integer

minRangeProbab=0.3

Type

Float

midRange=150

Type

Integer

midRangeProbab= 0.58

Type

Float

maxRange=500

Type

Integer

maxRangeProbab=0.04

Type

Float

memoryPointCamera="eye"

Class

Arma

Type

String

Description

MuzzleClass

memoryPointCamera = "GL eye";

model="[.p3d]"

Type

String

model = "\ca\a10\AGM65";

modelMagazine="[.p3d]"

Class

Arma

Type

String

modelMagazine="\misc\mag_univ"

Class

OFP

Type

String

modelOptics="[.p3d]"

Class

MuzzleClass

Type

String

Description

Optic model used in game. "-" defines 3d view from the model (point "eye").

modelOptics = "\ca\Weapons\G36_optics"; 
modelOptics = "-";

modelSpecial=[.p3d]""

Type

String

modes[]= {"this"}

Type

String;Type: Array

Description

Anything you care to claim as a class xxx.

modes[]= {"this"}; means all parameters necessary for the one and only mode are declared within the main body. Note this also gives the order of selection using the control key in-game.

modes[] = {"single", "burst", "auto"};

multiplier=1

Class

ModeClass

Type

Integer

Description

Ammunition used per shot.

muzzleEnd="konec hlavne"

Type

String

muzzlePos="usti hlavne"

Type

String

muzzles[]={"this"}

Type

Array

Description

Similarly to modes, if not declared, the assumed muzzle is "this".

muzzles[] = {"TimeBombMuzzle", "PipeBombMuzzle", "MineMuzzle", "MineEMuzzle"};

N

nameSound=""

Type

String

Description

Sound classname played when vehicle commander switches to this weapon?

nameSound = "smokeshell";

nameSound="weapon"

Class

OFP

Type

String

O

optics=true

Type

Boolean

opticsDisablePeripherialVision=0.67

Class

Arma

Type

Float

opticsFlare=true

Type

Boolean

opticsPPEffects[] = {}

Class

Arma

Type

Array

opticsZoomInit= 0.35

Class

MuzzleClass

Type

Float

Description

Optics field of view at default zoom in radians.

opticsZoomMax=0.35

Class

MuzzleClass

Type

Float

Description

Optics field of view at maximum zoom in radians.

opticsZoomMin=0.35

Class

MuzzleClass

Type

Float

Description

Optics field of view at minimum zoom in radians.

P

picture="[\][.pac]"

Type

String

Description

Defines weapon and magazine. See below.

primary=10

Type

Integer

R

recoil="Empty"

Class

ModeClass

Type

String

Description

Selects recoil defined in cfgRecoils class. Arma differs substantially in Recoil ability; much more of them, and very different names.

recoil = "AK74Recoil"

recoilProne=""

Class

ArmaModeClass

Type

String

Description

When prone, recoil can be set to slower values.

recoilProne = "AK74Recoil"

reloadAction=""

Class

Arma

Type

String

Description

Enumerated list.

reloadAction="ManActReloadMagazine"

Class

OFP

Type

String

reloadMagazineSound[]={"",1,1}

Class

MuzzleClass

Type

Array

Description

Sound played while changing magazines.

reloadMagazineSound[] = {"\ca\Weapons\Data\Sound\flare_reload", 0.000316228, 1};

reloadSound[]={"",1,1}

Type

Array

Description

Sound played after each shot.

reloadSound[] = {"\ca\Weapons\Data\Sound\gun125reload", 1, 1};

reloadTime=1.0

Class

ModeClass

Type

Float

Description

Time delay between each individual shot.

S

scope=0

Class

Arma

Type

Integer

Description

OFP had no scope token. Instead, it used scopeWeapon and scopeMagazine to distinguish who was what and when used.

2 = can use in-game, with a picture in gear present. 1 = can use in-game with no picture in gear.

scopeWeapon=0

Class

OFP

Type

Integer

scopeMagazine=0

Class

OFP

Type

Integer

Description

Used as couplets instead of scope.

selectionFireAnim="zasleh"

Class

Arma

Type

String

shortNameMagazine=""

Class

OFP

Type

String

Description

The descriptive magazine paragraph. Replaced in Arma by descriptionShort in the cfgMagazines Class.

shotFromTurret???

Class

Arma

Type

Boolean

Description

Meaning unknown. But "zasleh" animation is not working if set to 1.

showAimCursorInternal=true

Class

Arma

Type

Boolean

showEmpty=true

Type

Boolean

Description

If false weapon gets hidden from the player once there's no ammo left for it.

showSwitchAction=false

Class

Arma

Type

Boolean

showToPlayer=true

Class

ModeClass

Type

Boolean

Description

Some modes defined for AI usage (e.g. burst modes for full auto weapons) can be hidden from player with this parameter.

simulation="Weapon"

Class

Arma

Type

String

sound[]={"",1,1}

Class

ModeClass

Type

Array

Description

There are several sound types. Most are relevant to the weapon overall and specified in the main body, whilst sound[]= is specific to each mode.

The last parameter defines how fast the sound should be played. 1 means normal speed.

sound[] = {"\ca\Weapons\Data\Sound\AGS30_shot1", 10, 1};

soundBurst=true

Class

ArmaModeClass

Type

Boolean

Description

When set to false, the single shot sound can be used with burst mode - it will be played several times.

soundContinuous=false

Class

ModeClass

Type

Boolean

Description

If true, the sound for the next shot won't start before previous one ends. Thus you can prevent sound overlapping.

soundBegin[]={"sound",1}

Class

ArmaModeClass

Type

Array

soundBullet[]={"emptySound",1}

Class

ArmaModeClass

Type

Array

soundEnd[]={"sound",1}

Class

ArmaModeClass

Type

Array

soundLoop[]={"sound",1}

Class

ArmaModeClass

Type

Array

Description

Note that there is extensive use of soundloops in Arma. Most weapons elaborate on this basic, essentially OFP, structure with begin 1, 2, 3 loops etc.

soundFly[]

Type

Array

soundFly[] = {"\ca\Weapons\Data\Sound\rocket_fly1", 25.1189, 0.8};

soundServo[]

Type

Array

soundServo[] = {"", 0.0001, 1};

T

Type=WeaponHardMounted

Class

Arma

Type

Integer

U

UiPicture="[\][.pac]"

Class

Arma

Type

String

"\CA\weapons\data\Ico\i_aa_CA.paa";

uiPicture="ivojak"

Class

OFP

useAction=false

Class

ModeClass

Type

Boolean

useActionTitle=""

Class

ModeClass

Type

String

useActionTitle = "$STR_ACTION_PUTBOMB";

useAsBinocular=false

Type

Boolean

V

value=2

Class

Arma

Type

Integer

valueMagazine=2

Class

OFP

Type

Integer

valueWeapon=2

Class

OFP

Type

Integer

W

weaponType=WeaponHardMounted

Class

OFP

Type

Integer