CfgMagazines Config Reference: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Usage was not clear. Copied description from VBS Wiki.)
m (Text replacement - "\[ *((f|ht)tps?:\/\/[^ ]+) *\]" to "{{Link|$1|link}}")
 
(28 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Cfg ref|start}}
{{ConfigPage|start}}
==Introduction==
== Introduction ==
'''''cfgAmmo''''', '''''cfgMagazines''''', '''''cfgWeapons''''' and '''''cfgVehicles''''' are root classes defined in the engine's <tt>config.bin</tt>
'''''cfgAmmo''''', '''''cfgMagazines''''', '''''cfgWeapons''''' and '''''cfgVehicles''''' are root classes defined in the engine's {{hl|config.bin}}


These classes can be subsequently added to by addons inherent in the game or provided by ''oem''.
These classes can be subsequently added to by addons inherent in the game or provided by ''oem''.
Line 9: Line 9:
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.
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.


''Default'' values are shown in the legend. They come from the derived class <tt>CA_Magazine</tt> rather than the true <tt>default{}</tt> since almost everything derives from this class.
''Default'' values are shown in the legend. They come from the derived class {{hl|CA_Magazine}} rather than the true {{hl|default{}}} since almost everything derives from this class.


Nearly all values are identical to their {{Name|ofp|short}} equivalent.
Nearly all values are identical to their {{Name|ofp|short}} equivalent.
Line 15: Line 15:
'''Note''' that engines will accept ''integer'' values (or math strings) where a ''float'' would normally be expected.
'''Note''' that engines will accept ''integer'' values (or math strings) where a ''float'' would normally be expected.


''TokenNames'' marked ''{{Name|arma|short}}'' were introduced from {{Name|ofpe|short}} and beyond.
''TokenNames'' marked ''{{Name|arma1|short}}'' were introduced from {{Name|ofpe|short}} and beyond.


===Arma Enhancement===
=== Arma Enhancement ===
Arma introduced a new root class, ''cfgMagazines''.
Arma introduced a new root class, ''cfgMagazines''.


Line 24: Line 24:
Any given magazine can (obviously) only hold a specific ''cfgAmmo'' class.
Any given magazine can (obviously) only hold a specific ''cfgAmmo'' class.


In contrast, {{Name|ofp|short}} uses a rather tedious construct in it's ''cfgWeapons'' class to distinguish between weapon and magazine parameters.
In contrast, {{Name|ofp|short}} uses a rather tedious construct in it is ''cfgWeapons'' class to distinguish between weapon and magazine parameters.


The major alterations here are:
The major alterations here are:
{| class="bikitable"
{| class="wikitable"
|-
|-
! {{Name|ofp|short}}              !! {{Name|arma|short}}
! {{Name|ofp|short}}              !! {{Name|arma1|short}}
|-
|-
| <tt>ammo=</tt>                   || moved to ''cfgMagazines''
| {{hl|c= ammo=}}                   || moved to ''cfgMagazines''
|-
|-
| <tt>displayNameMagazine=</tt>   || moved to ''cfgMagazines'' and renamed ''DisplayName'' (of course)
| {{hl|c= displayNameMagazine=}}   || moved to ''cfgMagazines'' and renamed ''DisplayName'' (of course)
|-
|-
| <tt>magazines[] = {"this"};</tt> || <tt>magazines[] = {};</tt>
| {{hl|c= magazines[] = {"this"};}} || {{hl|c= magazines[] = {};}}
|-
|-
| <tt>magazineType=</tt>           || moved to ''cfgMagazines'' and renamed ''Type''
| {{hl|c= magazineType=}}           || moved to ''cfgMagazines'' and renamed ''Type''
|-
|-
| <tt>maxLeadSpeed=</tt>           || moved to ''cfgMagazines''
| {{hl|c= maxLeadSpeed=}}           || moved to ''cfgMagazines''
|-
|-
| <tt>scopeWeapon=</tt>           || renamed ''scope''
| {{hl|c= scopeWeapon=}}           || renamed ''scope''
|-
|-
| <tt>scopeMagazine=</tt>         || moved to ''cfgMagazines'' and renamed ''scope''
| {{hl|c= scopeMagazine=}}         || moved to ''cfgMagazines'' and renamed ''scope''
|-
|-
| <tt>shortNameMagazine=</tt>     || moved to ''cfgMagazines'' and renamed ''descriptionShort''?
| {{hl|c= shortNameMagazine=}}     || moved to ''cfgMagazines'' and renamed ''descriptionShort''?
|}
|}


===Modifications===
=== Modifications ===
Unlike it's ''cfgAmmo'' and ''cfgWeapon'' cousins: all bets are off. There is, a default class (the substance of this document), but it, and all other classes in ''cfgMagazines'' are deletable/erasable/modifiable.
Unlike it is ''cfgAmmo'' and ''cfgWeapon'' cousins: all bets are off. There is, a default class (the substance of this document), but it, and all other classes in ''cfgMagazines'' are deletable/erasable/modifiable.


Caution should be exercised about 'expected' default values when inheriting. ANY added ''pbo'' can alter them substantially before your very eyes.
Caution should be exercised about 'expected' default values when inheriting. ANY added ''pbo'' can alter them substantially before your very eyes.


;Warning
;Warning
:Unlike {{Name|ofp|short}}, you cannot have the '''same''' <tt>cfgMagazines.ClassName</tt>
:Unlike {{Name|ofp|short}}, you cannot have the '''same''' {{hl|cfgMagazines.ClassName}}
:If you specify a rifle, and it's magazine with the same classname, the in-game gear selection dialog get's mightily confused. It's a noisy, awful display to begin with. Don't, make it worse.
:If you specify a rifle, and it is magazine with the same classname, the in-game gear selection dialog get's mightily confused. It's a noisy, awful display to begin with. Don't, make it worse.


==Alphabetical Order==
== Alphabetical Order ==
{{Cfg ref|abc}}
{{ConfigPage|abc}}
===A===
=== A ===
====ammo=""====
==== ammo="" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
;Description: Name of the ''cfgAmmo'' class which this magazine holds.
;Description: Name of the ''cfgAmmo'' class which this magazine holds.


<syntaxhighlight lang="c">
<syntaxhighlight lang="cpp">
ammo = B_30mm_HE; //eg
ammo = B_30mm_HE; //eg
</syntaxhighlight>
</syntaxhighlight>


===C===
=== C ===
====class InventoryPlacements{}====
==== class InventoryPlacements{} ====
{{Example needed}}
{{Wiki|stub}}


====class Library====
==== class Library ====
<syntaxhighlight lang="c">
<syntaxhighlight lang="cpp">
class Library
class Library
{
{
Line 80: Line 80:
</syntaxhighlight>
</syntaxhighlight>


====count=30====
==== count=30 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: The amount of ammo this magazine holds.
;Description: The amount of ammo this magazine holds.


===D===
=== D ===
====descriptionShort=""====
==== descriptionShort="" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
;Description: The descriptive Name of the ammunition.
;Description: The descriptive Name of the ammunition.


<syntaxhighlight lang="c">
<syntaxhighlight lang="cpp">
descriptionShort = $STR_SN_MAVERICK;
descriptionShort = "$STR_SN_MAVERICK";
descriptionShort = "Beretta Ammo";
descriptionShort = "Beretta Ammo";
</syntaxhighlight>
</syntaxhighlight>


====displayName=""====
==== displayName="" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
;Description: The descriptive Name of the magazine. In {{Name|ofp|short}}, this was called ''DisplayNameMagazine''.
;Description: The descriptive Name of the magazine. In {{Name|ofp|short}}, this was called ''DisplayNameMagazine''.


===I===
==== displayNameMFDFormat="" ====
====initSpeed=900====
;Type: [[TokenNameValueTypes|String]]
;Description: Custom MFD name used by "ammoFormat" source. Example: displayNameMFDFormat = "A%1C", %1 for ammo count, %2 remaining mags count, %3 total mags count, %4 mag capacity. Example displayNameMFDFormat  = "HEAT";
 
==== deleteIfEmpty=-1"" ====
;Type: [[TokenNameValueTypes|Integer]]
;Description: Decides if magazine is automatically removed from inventory when ammo capacity is 0. 0 - never remove, 1 - always remove, -1 default behavior (auto detect, removes magazine when magazine capacity is 1 [count = 1] & magazine is empty). Default value is -1.
 
=== I ===
==== initSpeed=900 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: Starting speed of missile.
;Description: Starting speed of missile.


===M===
=== M ===
====maxLeadSpeed = 23;====
==== maxLeadSpeed = 23; ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]


====model="\ca\weapons\mag_univ[.p3d]"====
==== model="\ca\weapons\mag_univ[.p3d]" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
;Description: The mag model. Identical to {{Name|ofp|short}}.
;Description: The mag model. Identical to {{Name|ofp|short}}.


====modelSpecial="[.p3d]"====
==== modelSpecial="[.p3d]" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]


===N===
==== modelSpecialIsProxy="1" ====
====nameSound="magazine"====
;Type: [[TokenNameValueTypes|Integer]]
;Description: Controls if modelSpecial is using magazine proxy tech.
 
==== muzzleImpulseFactor[]={1.0,1.0} ====
;Type: [[TokenNameValueTypes|Float]] or [[TokenNameValueTypes|Array]]
;Description: Coefficient to recoil force (only on vehicles), which is calculated from ammo hit value & speed defined in magazine. Default value is 1. Can be defined as a float or an array (torque, force) {{Link|https://forums.bistudio.com/forums/topic/140837-development-branch-changelog/?do{{=}}findComment&comment{{=}}3241029|link}}.
muzzle Impulse applied when shooting is calculated by:  ''p = 0.25kg * (hit/13) * initSpeed * muzzleImpulseFactor[0] // initspeed in m/s, rest unitless.
 
=== N ===
==== nameSound="magazine" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
Category for radio protocol. (Use Missiles, Cannon etc.)
Category for radio protocol. (Use Missiles, Cannon etc.)


===P===
=== P ===
====picture="[\][[.pac]"====
==== picture="[\][[.pac]" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]
;Description: Picture shown in gear for this mag. See ''cfgAmmo'' for warnings about picture paths.
;Description: Picture shown in gear for this mag. See ''cfgAmmo'' for warnings about picture paths.


===R===
=== R ===
====reloadAction="ManActReloadMagazine"====
==== reloadAction="ManActReloadMagazine" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]


===S===
=== S ===
====scope=protected====
==== scope=protected ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: {{Name|ofp|short}} name was ''ScopeMagazine''.
;Description: {{Name|ofp|short}} name was ''ScopeMagazine''.
Values: <tt>private</tt>, <tt>protected</tt>, <tt>public</tt>.
Values: {{hl|private}}, {{hl|protected}}, {{hl|public}}.


====selectionFireAnim="zasleh"====
==== selectionFireAnim="zasleh" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]


====simulation="ProxyMagazines"====
==== simulation="ProxyMagazines" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]


===T===
=== T ===
====type=256====
==== type=256 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: {{Name|ofp|short}} name was ''MagazineType''. See ''cfgWeapons'' for the CHANGES between {{Name|ofp|short}} and {{Name|arma|short}} for this value.
;Description: {{Name|ofp|short}} name was ''MagazineType''. See ''cfgWeapons'' for the CHANGES between {{Name|ofp|short}} and {{Name|arma1|short}} for this value.


===U===
=== U ===
====useAction=0====
==== useAction=0 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]


====useActionTitle=""====
==== useActionTitle="" ====
;Type: [[TokenNameValueTypes|String]]
;Type: [[TokenNameValueTypes|String]]


===V===
=== V ===
====value=1====
==== value=1 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: Formerly known as ''ValueMagazine'' in {{Name|ofp|short}}.
;Description: Formerly known as ''ValueMagazine'' in {{Name|ofp|short}}.


===W===
=== W ===
====weight=0====
==== weight=0 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]


==Additional Values==
== Additional Values ==
Because just about anything can be added to these classes it is not overly useful to attempt to define most of them. For whatever reason, and unlike other root classes, the engine doesn't need these tokens declared in <tt>default{}</tt>.
Because just about anything can be added to these classes it is not overly useful to attempt to define most of them. For whatever reason, and unlike other root classes, the engine doesn't need these tokens declared in {{hl|default{}}}.


====lastRoundsTracer=4====
==== lastRoundsTracer=4 ====
{{Example needed}}
{{Wiki|stub}}


====tracersEvery=4====
==== tracersEvery=4 ====
;Type: [[TokenNameValueTypes|Integer]]
;Type: [[TokenNameValueTypes|Integer]]
;Description: Sets the interval between tracers.
;Description: Sets the interval between tracers.




{{Cfg ref|end}}
{{ConfigPage|end}}
 


[[category:Operation Flashpoint: Editing]]
{{GameCategory|ofp|Editing}}
[[Category:ArmA: Addon Configuration]]
{{GameCategory|arma1|Addon Configuration}}

Latest revision as of 19:20, 28 April 2023

CfgMoves Config Reference CfgVehicles Config Reference CfgWeapons Config Reference CfgMagazines Config Reference CfgAmmo 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 inherent 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.

Default values are shown in the legend. They come from the derived class CA_Magazine rather than the true default{} since almost everything derives from this class.

Nearly all values are identical to their OFP equivalent.

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

TokenNames marked ArmA were introduced from OFP:E and beyond.

Arma Enhancement

Arma introduced a new root class, cfgMagazines.

The magazines it declares are selected for use by specific cfgWeapons.

Any given magazine can (obviously) only hold a specific cfgAmmo class.

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

The major alterations here are:

OFP ArmA
ammo= 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
scopeWeapon= renamed scope
scopeMagazine= moved to cfgMagazines and renamed scope
shortNameMagazine= moved to cfgMagazines and renamed descriptionShort?

Modifications

Unlike it is cfgAmmo and cfgWeapon cousins: all bets are off. There is, a default class (the substance of this document), but it, and all other classes in cfgMagazines are deletable/erasable/modifiable.

Caution should be exercised about 'expected' default values when inheriting. ANY added pbo can alter them substantially before your very eyes.

Warning
Unlike OFP, you cannot have the same cfgMagazines.ClassName
If you specify a rifle, and it is magazine with the same classname, the in-game gear selection dialog get's mightily confused. It's a noisy, awful display to begin with. Don't, make it worse.

Alphabetical Order

A

ammo=""

Type
String
Description
Name of the cfgAmmo class which this magazine holds.
ammo = B_30mm_HE; //eg

C

class InventoryPlacements{}

This article is a Stub. You can help BI Community Wiki by expanding it.

class Library

class Library
{
    libTextDesc = "";
};

count=30

Type
Integer
Description
The amount of ammo this magazine holds.

D

descriptionShort=""

Type
String
Description
The descriptive Name of the ammunition.
descriptionShort = "$STR_SN_MAVERICK";
descriptionShort = "Beretta Ammo";

displayName=""

Type
String
Description
The descriptive Name of the magazine. In OFP, this was called DisplayNameMagazine.

displayNameMFDFormat=""

Type
String
Description
Custom MFD name used by "ammoFormat" source. Example: displayNameMFDFormat = "A%1C", %1 for ammo count, %2 remaining mags count, %3 total mags count, %4 mag capacity. Example displayNameMFDFormat = "HEAT";

deleteIfEmpty=-1""

Type
Integer
Description
Decides if magazine is automatically removed from inventory when ammo capacity is 0. 0 - never remove, 1 - always remove, -1 default behavior (auto detect, removes magazine when magazine capacity is 1 [count = 1] & magazine is empty). Default value is -1.

I

initSpeed=900

Type
Integer
Description
Starting speed of missile.

M

maxLeadSpeed = 23;

Type
Integer

model="\ca\weapons\mag_univ[.p3d]"

Type
String
Description
The mag model. Identical to OFP.

modelSpecial="[.p3d]"

Type
String

modelSpecialIsProxy="1"

Type
Integer
Description
Controls if modelSpecial is using magazine proxy tech.

muzzleImpulseFactor[]={1.0,1.0}

Type
Float or Array
Description
Coefficient to recoil force (only on vehicles), which is calculated from ammo hit value & speed defined in magazine. Default value is 1. Can be defined as a float or an array (torque, force) link.

muzzle Impulse applied when shooting is calculated by: p = 0.25kg * (hit/13) * initSpeed * muzzleImpulseFactor[0] // initspeed in m/s, rest unitless.

N

nameSound="magazine"

Type
String

Category for radio protocol. (Use Missiles, Cannon etc.)

P

picture="[\][[.pac]"

Type
String
Description
Picture shown in gear for this mag. See cfgAmmo for warnings about picture paths.

R

reloadAction="ManActReloadMagazine"

Type
String

S

scope=protected

Type
Integer
Description
OFP name was ScopeMagazine.

Values: private, protected, public.

selectionFireAnim="zasleh"

Type
String

simulation="ProxyMagazines"

Type
String

T

type=256

Type
Integer
Description
OFP name was MagazineType. See cfgWeapons for the CHANGES between OFP and ArmA for this value.

U

useAction=0

Type
Integer

useActionTitle=""

Type
String

V

value=1

Type
Integer
Description
Formerly known as ValueMagazine in OFP.

W

weight=0

Type
Integer

Additional Values

Because just about anything can be added to these classes it is not overly useful to attempt to define most of them. For whatever reason, and unlike other root classes, the engine doesn't need these tokens declared in default{}.

lastRoundsTracer=4

This article is a Stub. You can help BI Community Wiki by expanding it.

tracersEvery=4

Type
Integer
Description
Sets the interval between tracers.


Retrieved from "https://community.bistudio.com/wiki?title=CfgMagazines_Config_Reference&oldid=340296"