7erra/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (→‎appId: removed link to appId store page)
(bis_fnc_arsenal variables)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{TOC|side|1||nonum}}
=== Variables ===
<div class="cfg_reference">
This is a list of all the variables that are used by the Virtual Arsenal.
This page contains information about the DLC Content Browser and what attributes and classes have to be added to the CfgMods class.
{| class="wikitable"
|-
! colspan=3 | [[missionNamespace]]
|-
! Variable !! Data Type !! Explanation
|-
| BIS_fnc_arsenal_data || [[Array]] of arrays of [[String|strings]] || All available items that can be accessed in the Arsenal (not the actual content!). Format:<br>


== Alphabetical Order ==
{| class="wikitable"
<div class="abc">
|-
=== A ===
! Index !! Content
==== class Achievements ====
|-
List of unlockable Steam achievements added by the DLC. See [[#Special Subclasses|this section]].
| 0 || Primary Weapons
|-
| 1 || Secondary Weapons
|-
| 2 || Handguns
|-
| 3 || Uniforms
|-
| 4 || Vests
|-
| 5 || Backpacks
|-
| 6 || Headgear
|-
| 7 || Goggles
|-
| 8 || NVGs
|-
| 9 || Binoculars
|-
| 10 || Maps
|-
| 11 || GPS
|-
| 12 || Radio
|-
| 13 || Compass
|-
| 14 || Watch
|-
| 15 || Face (empty)
|-
| 16 || Voice (empty)
|-
| 17 || Insignia (empty)
|-
| 18 || Optic attachments (empty)
|-
| 19 || Side attachments (empty)
|-
| 20 || Muzzle attachments (empty)
|-
| 21 || Compatible magazines (empty)
|-
| 22 || Grenades
|-
| 23 || Placeables
|-
| 24 || Miscellaneous
|-
| 25 || Bipod attachments (empty)
|-
| 26 || All magazines
|}


==== appId ====
|}
Steam App ID of the DLC. Part of the Steam page: <nowiki>https://store.steampowered.com/app/appId</nowiki>, eg https://store.steampowered.com/app/798390 (Tanks DLC)
<syntaxhighlight lang="cpp">appId = 798390;</syntaxhighlight>
 
==== artwork ====
Image shown in the Content Browser (format: 724x1024 px) and as background in the Preview.
<syntaxhighlight lang="cpp">artwork = "\A3\Data_F_Tank\Logos\arma3_tank_artwork.jpg";</syntaxhighlight>
 
==== class Assets ====
Config containing assets such as vehicles, gear and objects that are added by the DLC. See [[#Special Subclasses|this section]].
 
=== D ===
==== dlcColor ====
Color of the frame in the overview and most elements in the detailed view.
<syntaxhighlight lang="cpp">dlcColor[] = {0.215686,0.368627,0.368627,1};</syntaxhighlight>
 
=== L ===
==== logoTitle ====
Big logo at the top of the Preview page. Format: 1024x512 px.
<syntaxhighlight lang="cpp">logoTitle = "\A3\Data_F_Tank\Logos\arma3_tank_logoTitle_ca.paa";</syntaxhighlight>
 
=== M ===
==== class Multiplayer ====
List of multiplayer content added by the DLC. See [[#Special Subclasses|this section]].
 
=== N ===
==== name ====
Used as title when nameShort is not defined.
<syntaxhighlight lang="cpp">name = "$STR_A3_cfgmods_tank_name0";</syntaxhighlight>
 
==== nameShort ====
Title used in the overview (all upper case).
<syntaxhighlight lang="cpp">name = "Tanks";</syntaxhighlight>
 
=== S ===
==== class Singleplayer ====
Config containing subclasses with information about singleplayer content added by the DLC. See [[#Special Subclasses|this section]].
 
==== soon ====
Use 0 for unreleased content. Clicking on the DLC in the Content Browser will take you to the store page directly instead of showing the DLC Preview.
<syntaxhighlight lang="cpp">soon = 0;</syntaxhighlight>
 
=== V ===
==== video ====
Video shown when hovering in the Content Browser, same format as [[#artwork|artwork]].
<syntaxhighlight lang="cpp">video = "\A3\Data_F_Tank\Video\preview_tank.ogv";</syntaxhighlight>
 
</div>
 
 
== Special Subclasses ==
The subclasses of {{ic|Assets}}, {{ic|Singleplayer}}, {{ic|Multiplayer}} and {{ic|Achievements}} can contain the following attributes:
<div class="abc">
=== A ===
==== achievement ====
Internal achievement identifier.
<syntaxhighlight lang="cpp">achievement = "AchTankTTBronze";</syntaxhighlight>
 
==== achievementHidden ====
Shows "Unknown" instead of details about the achievement unless it has been unlocked already.
<syntaxhighlight lang="cpp">achievementHidden = 1;</syntaxhighlight>
 
=== D ===
==== displayName ====
Title of the info card.
<syntaxhighlight lang="cpp">displayName = "T-140 Angara";</syntaxhighlight>
 
=== O ===
==== overviewPicture ====
Image displayed in the left window.
<syntaxhighlight lang="cpp">overviewPicture = "\a3\data_f_tank\images\angara_ca.paa";</syntaxhighlight>
 
=== R ===
==== reference ====
Can be used instead of {{ic|displayName}} and {{ic|overviewPicture}}. In this case the information will be pulled from the provided config.
<syntaxhighlight lang="cpp">reference[] = {"CfgVehicles","MBT_04_cannon_base_F"};</syntaxhighlight>
This corresponds to the following config path: {{ic|[[configFile]] >> "CfgVehicles" >> "MBT_04_cannon_base_F"}}
 
=== T ===
==== tryAsset ====
Array containing information to open the vehicle/unit/equipment in the [[Arma 3: Arsenal|Virtual Arsenal]]. Format is: {{ic|{BIS_fnc_arsenal_typeDefault, BIS_fnc_arsenal_defaultClass, BIS_fnc_garage_defaultClass, BIS_fnc_arsenal_customCode}}}.
<syntaxhighlight lang="cpp">tryAsset[] = {1,"O_crew_f","O_MBT_04_cannon_F"};</syntaxhighlight>
</div>
 
 
</div>

Latest revision as of 02:11, 6 September 2021

Variables

This is a list of all the variables that are used by the Virtual Arsenal.

missionNamespace
Variable Data Type Explanation
BIS_fnc_arsenal_data Array of arrays of strings All available items that can be accessed in the Arsenal (not the actual content!). Format:
Index Content
0 Primary Weapons
1 Secondary Weapons
2 Handguns
3 Uniforms
4 Vests
5 Backpacks
6 Headgear
7 Goggles
8 NVGs
9 Binoculars
10 Maps
11 GPS
12 Radio
13 Compass
14 Watch
15 Face (empty)
16 Voice (empty)
17 Insignia (empty)
18 Optic attachments (empty)
19 Side attachments (empty)
20 Muzzle attachments (empty)
21 Compatible magazines (empty)
22 Grenades
23 Placeables
24 Miscellaneous
25 Bipod attachments (empty)
26 All magazines