CfgMissions: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - ";[ ]+ " to "; ") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 6: | Line 6: | ||
== Classes == | == Classes == | ||
{| class="wikitable sortable" | {| class="wikitable sortable align-center-col-1" | ||
! Introduced in | ! Introduced in | ||
! Param name | ! Param name | ||
Line 12: | Line 12: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== Campaigns ==== | ==== Campaigns ==== | ||
Line 30: | Line 30: | ||
|- | |- | ||
| {{GVI|arma3|1.00}} | |||
| | | | ||
==== Episodic Campaigns ==== | ==== Episodic Campaigns ==== | ||
Line 42: | Line 42: | ||
{ | { | ||
// Each of these definitions are applied to the root campaign | // Each of these definitions are applied to the root campaign | ||
briefingname = $STR_A3_CampaignName; | briefingname = "$STR_A3_CampaignName"; | ||
overviewText = $STR_A3_CampaignOverview; | overviewText = "$STR_A3_CampaignOverview"; | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa"; | overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa"; | ||
// Classes of episodes included | // Classes of episodes included | ||
Line 67: | Line 67: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== Missions ==== | ==== Missions ==== | ||
Line 106: | Line 106: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== Tutorial ==== | ==== Tutorial ==== | ||
Line 112: | Line 112: | ||
|- | |- | ||
| {{GVI|tkoh|1.00}} | |||
| | | | ||
==== TimeTrials ==== | ==== TimeTrials ==== | ||
Line 118: | Line 118: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== MPMissions ==== | ==== MPMissions ==== | ||
Line 130: | Line 130: | ||
class MP_ZGM_m14 // class name MUST match the name in the 'directory' path | class MP_ZGM_m14 // class name MUST match the name in the 'directory' path | ||
{ | { | ||
briefingName = $STR_A3_MasterTanoa_missionName; | briefingName = "$STR_A3_MasterTanoa_missionName"; | ||
directory = "A3\missions_f_exp\mpscenarios\mp_zgm_m14.Tanoa"; // <--- match | directory = "A3\missions_f_exp\mpscenarios\mp_zgm_m14.Tanoa"; // <--- match | ||
}; | }; | ||
Line 138: | Line 138: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== Templates ==== | ==== Templates ==== | ||
Line 153: | Line 153: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== MPTemplates ==== | ==== MPTemplates ==== | ||
Line 159: | Line 159: | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== Procedural ==== | ==== Procedural ==== | ||
Line 170: | Line 170: | ||
Following params works for all mission/campaign classes placed in parent classes listed above. | Following params works for all mission/campaign classes placed in parent classes listed above. | ||
{| class="wikitable sortable" | {| class="wikitable sortable align-center-col-1" | ||
! Introduced in | ! Introduced in | ||
! Param name | ! Param name | ||
! Type | ! Type | ||
! class="unsortable"| Description | ! class="unsortable" | Description | ||
! Compatibility | ! Compatibility | ||
|- | |- | ||
| {{GVI|arma1|1.00}} | |||
| | | | ||
==== directory ==== | ==== directory ==== | ||
|[[String]] | | [[String]] | ||
| | | | ||
* Missions - path to [[Mission_Editor:_External#Mission_Folder|mission folder]] (where mission.sqm is placed) | * Missions - path to [[Mission_Editor:_External#Mission_Folder|mission folder]] (where mission.sqm is placed) | ||
Line 189: | Line 189: | ||
|- | |- | ||
| {{GVI|tkoh|1.00}} | |||
| | | | ||
==== briefingName ==== | ==== briefingName ==== | ||
|[[String]] | | [[String]] | ||
| Mission name overriding name set in [[Mission_Editor:_Intel#Name|Intel menu]]. | | Mission name overriding name set in [[Mission_Editor:_Intel#Name|Intel menu]]. | ||
| Not in Campaigns | | Not in Campaigns | ||
|- | |- | ||
| {{GVI|tkoh|1.00}} | |||
| | | | ||
==== overviewText ==== | ==== overviewText ==== | ||
|[[String]] | | [[String]] | ||
| Custom [[Content_Overview|overview description]] | | Custom [[Content_Overview|overview description]] | ||
| Not in MPMissions and MPTemplates | | Not in MPMissions and MPTemplates | ||
|- | |- | ||
| {{GVI|tkoh|1.00}} | |||
| | | | ||
==== overviewPicture ==== | ==== overviewPicture ==== | ||
|[[String]] | | [[String]] | ||
| Path to custom [[Content_Overview|overview picture]] | | Path to custom [[Content_Overview|overview picture]] | ||
| Not in MPMissions and MPTemplates | | Not in MPMissions and MPTemplates | ||
|- | |- | ||
| {{GVI|tkoh|1.00}} | |||
| | | | ||
==== author ==== | ==== author ==== | ||
|[[String]] | | [[String]] | ||
| [[Content Authorship]] signature | | [[Content Authorship]] signature | ||
| Not in MPMissions and MPTemplates | | Not in MPMissions and MPTemplates | ||
Line 224: | Line 224: | ||
== Examples == | == Examples == | ||
{| class="wikitable mw-collapsible mw-collapsed" width="100%" | {| class="wikitable mw-collapsible mw-collapsed" width="100%" | ||
Line 281: | Line 280: | ||
class Armory | class Armory | ||
{ | { | ||
onLoadMission = $STR_LIB_ONLOAD; | onLoadMission = "$STR_LIB_ONLOAD"; | ||
debriefing = 0; | debriefing = 0; | ||
playerKilledScript = "\ca\missions\armory\data\scripts\respawn.sqf"; | playerKilledScript = "\ca\missions\armory\data\scripts\respawn.sqf"; | ||
Line 347: | Line 346: | ||
{ | { | ||
// Each of these definitions are applied to the root campaign | // Each of these definitions are applied to the root campaign | ||
briefingname = $STR_A3_CampaignName; | briefingname = "$STR_A3_CampaignName"; | ||
overviewText = $STR_A3_CampaignOverview; | overviewText = "$STR_A3_CampaignOverview"; | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa"; | overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa"; | ||
// Classes of episodes included | // Classes of episodes included | ||
campaigns[] = {StageA, StageB, StageC}; | campaigns[] = { "StageA", "StageB", "StageC" }; | ||
class StageA | class StageA | ||
{ | { | ||
Line 372: | Line 371: | ||
class Showcases | class Showcases | ||
{ | { | ||
displayName = $STR_A3_CFGMISSIONS_SHOWCASES0; | displayName = "$STR_A3_CFGMISSIONS_SHOWCASES0"; | ||
briefingName = $STR_A3_CFGMISSIONS_SHOWCASES0; | briefingName = "$STR_A3_CFGMISSIONS_SHOWCASES0"; | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
overviewPicture = "a3\Missions_F_Beta\data\img\Campaign_overview_CA.paa"; | overviewPicture = "a3\Missions_F_Beta\data\img\Campaign_overview_CA.paa"; | ||
overviewText = $STR_A3_CFGMISSIONS_SHOWCASES0; | overviewText = "$STR_A3_CFGMISSIONS_SHOWCASES0"; | ||
class Showcase_Combined_arms | class Showcase_Combined_arms | ||
{ | { | ||
briefingName = $STR_A3_Showcase_Combined_Arms_Mission_Name; | briefingName = "$STR_A3_Showcase_Combined_Arms_Mission_Name"; | ||
directory = "a3\Missions_F_Beta\Showcases\Showcase_Combined_arms.Stratis"; | directory = "a3\Missions_F_Beta\Showcases\Showcase_Combined_arms.Stratis"; | ||
}; | }; | ||
Line 395: | Line 394: | ||
class Challenges | class Challenges | ||
{ | { | ||
briefingName = $STR_A3_CHALLENGES_NAME; | briefingName = "$STR_A3_CHALLENGES_NAME"; | ||
overviewText = $STR_A3_CHALLENGES_OVERVIEW; | overviewText = "$STR_A3_CHALLENGES_OVERVIEW"; | ||
overviewPicture = "\a3\Missions_F_Beta\data\img\Challenges_overview_CA.paa"; | overviewPicture = "\a3\Missions_F_Beta\data\img\Challenges_overview_CA.paa"; | ||
// Firing Drills | // Firing Drills | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
class Firing_Drills | class Firing_Drills | ||
{ | { | ||
briefingName = $STR_A3_FIRING_DRILLS_NAME; | briefingName = "$STR_A3_FIRING_DRILLS_NAME"; | ||
overviewText = $STR_A3_FIRING_DRILLS_OVERVIEW; | overviewText = "$STR_A3_FIRING_DRILLS_OVERVIEW"; | ||
overviewPicture = "\a3\Missions_F_Beta\data\img\FiringDrills_overview_CA.paa"; | overviewPicture = "\a3\Missions_F_Beta\data\img\FiringDrills_overview_CA.paa"; | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
class SP_FD04 // Green | class SP_FD04 // Green | ||
{ | { | ||
directory = "a3\Missions_F_Beta\Challenges\firing_drills\sp_fd04.stratis"; | directory = "a3\Missions_F_Beta\Challenges\firing_drills\sp_fd04.stratis"; | ||
briefingName = $STR_A3_FIRING_DRILLS_SP_FD04_NAME; | briefingName = "$STR_A3_FIRING_DRILLS_SP_FD04_NAME"; | ||
overviewText = $STR_A3_FIRING_DRILLS_SP_FD04_OVERVIEW; | overviewText = "$STR_A3_FIRING_DRILLS_SP_FD04_OVERVIEW"; | ||
overviewPicture = "\a3\Missions_F_Beta\data\img\SP_FD04_overview_CA.paa"; | overviewPicture = "\a3\Missions_F_Beta\data\img\SP_FD04_overview_CA.paa"; | ||
author = $STR_A3_Bohemia_Interactive; | author = "$STR_A3_Bohemia_Interactive"; | ||
}; | }; | ||
}; | }; |
Revision as of 21:18, 13 March 2023
CfgMissions contains list of all playable content available for players in ingame menus. It is core of missions exported in Addon Format.
Classes
Introduced in | Param name | Description |
---|---|---|
1.00 |
Campaigns |
Regular campaigns. For information on how to configure the campaigns themselves, please see the Campaign Description.ext page.
class Campaigns
{
class Bootcamp
{
directory = "A3\Missions_F_Bootcamp\Campaign";
filterGroup = 3; // Only bootcamp campaign will be listed in Campaign dialogue invoked by Bootcamp button.
// include the campaign description.ext to make its content re-usable outside of the campaign
#include "\A3\Missions_F_Bootcamp\Campaign\description.ext"
};
};
|
1.00 |
Episodic Campaigns |
Arma 3 has introduced the ability to configure episodic campaigns, as seen with the official The East Wind campaign. Upon expanding the main tree, you will see all available episodes which, when expanded as well, function as a regular campaign. class Campaigns
{
class RootCampaign
{
// Each of these definitions are applied to the root campaign
briefingname = "$STR_A3_CampaignName";
overviewText = "$STR_A3_CampaignOverview";
author = "$STR_A3_Bohemia_Interactive";
overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa";
// Classes of episodes included
campaigns[] = { StageA, StageB, StageC };
class StageA
{
directory = "A3\Missions_F_EPA\Campaign";
// include the campaign description.ext to make it is content re-usable outside of the campaign
#include "\A3\Missions_F_EPA\Campaign\description.ext"
};
class StageB
{
directory = "A3\Missions_F_EPA\CampaignDummy";
};
class StageC
{
directory = "A3\Missions_F_EPA\CampaignDummy2";
};
};
};
|
1.00 |
Missions |
Singleplayer missions. Menu name can vary in different projects:
class Missions
{
class SP_WarWelcome
{
directory = "ca\missions\Scenarios\SP_WarWelcome.utes";
};
};
You can also group your missions into subfolders class Missions
{
class PMC_Missions
{
//--- Subfolder name
displayName="$STR_pmc_scenarios_name";
//--- Subfolder overview
overview="ca\missions2_pmc\overview.html";
//--- List of missions
class SPP01_PMC
{
directory = "ca\missions2_pmc\scenarios\SPP03.ProvingGrounds_PMC";
};
};
};
|
1.00 |
Tutorial |
Tutorial scenarios. Structure same as Missions. |
1.00 |
TimeTrials |
Time Trial scenarios. Structure same as Missions. |
1.00 |
MPMissions |
Multiplayer missions. Structure same as Missions.
class CfgMissions
{
class MPMissions
{
//--- ZEUS
class MP_ZGM_m14 // class name MUST match the name in the 'directory' path
{
briefingName = "$STR_A3_MasterTanoa_missionName";
directory = "A3\missions_f_exp\mpscenarios\mp_zgm_m14.Tanoa"; // <--- match
};
};
};
|
1.00 |
Templates |
Singleplayer templates. Accessable through <My Missions> in SP missions list.
class Templates
{
class ST_BasicEast
{
directory = "ca\missions\Templates\Basic.East";
};
};
|
1.00 |
MPTemplates |
Multiplayer templates. Accessable through <My Missions> in MP missions list. |
1.00 |
Procedural |
Procedural missions. Exclusive for Armory. |
Params
Following params works for all mission/campaign classes placed in parent classes listed above.
Introduced in | Param name | Type | Description | Compatibility |
---|---|---|---|---|
1.00 |
directory |
String |
directory = "ca\missions\Scenarios\SP_WarWelcome.utes";
|
N/A |
1.00 |
briefingName |
String | Mission name overriding name set in Intel menu. | Not in Campaigns |
1.00 |
overviewText |
String | Custom overview description | Not in MPMissions and MPTemplates |
1.00 |
overviewPicture |
String | Path to custom overview picture | Not in MPMissions and MPTemplates |
1.00 |
author |
String | Content Authorship signature | Not in MPMissions and MPTemplates |
You can also put any Description.ext param in mission class.
Examples
Arma 2: Operation Arrowhead Missions |
---|
For simplicity, every parent class contains only one mission example |
class CfgMissions
{
class Missions
{
class SP_Benchmark //03
{
directory = "ca\missions_e\scenarios\SPE1_Benchmark1.takistan";
};
};
class MPMissions
{
class MPE_HikeInTheHills
{
directory = "ca\missions_e\MPScenarios\MPE1_HikeInTheHills.Takistan";
};
};
class MPTemplates
{
class MTE_Deathmatch
{
directory = "ca\missions_e\MPTemplates\MPTE_Deathmatch";
}
};
class Templates
{
class ST_BasicEast
{
directory = "ca\missions_e\Templates\Basic.East";
};
};
class Campaigns
{
class Arrowhead
{
directory = "ca\missions_e\campaign";
};
};
class Tutorial
{
class TE01
{
directory = "ca\missions_e\Bootcamp\TE01_Basic_controls.Zargabad";
};
};
class Procedural
{
class Armory
{
onLoadMission = "$STR_LIB_ONLOAD";
debriefing = 0;
playerKilledScript = "\ca\missions\armory\data\scripts\respawn.sqf";
onPauseScript = "\ca\missions\armory\data\scripts\pauseOnload.sqf";
onCheat = "[_this] call LIB_onCheatFunction";
};
};
};
|
Arma 2: Private Military Company Missions |
---|
class CfgMissions
{
class Missions
{
class PMC_Missions
{
displayName="$STR_pmc_scenarios_name";
overview="ca\missions2_pmc\overview.html";
class SPP01_PMC
{
directory = "ca\missions2_pmc\scenarios\SPP03.ProvingGrounds_PMC";
};
class SPP02_PMC
{
directory = "ca\missions2_pmc\scenarios\SPP02.ProvingGrounds_PMC";
};
class SPP03_PMC
{
directory = "ca\missions2_pmc\scenarios\SPP01.Takistan";
};
class SPPXX_PMC
{
directory = "ca\missions2_pmc\scenarios\SPP00.Zargabad";
};
};
};
class Templates
{
class SupplyDrop
{
directory = "ca\missions2_PMC\Templates\SupplyDrop.West";
};
};
};
|
Arma 3 Missions |
---|
class CfgMissions
{
// Campaigns
class Campaigns
{
class RootCampaign
{
// Each of these definitions are applied to the root campaign
briefingname = "$STR_A3_CampaignName";
overviewText = "$STR_A3_CampaignOverview";
author = "$STR_A3_Bohemia_Interactive";
overviewPicture = "a3\Missions_F_EPA\data\img\Campaign_overview_CA.paa";
// Classes of episodes included
campaigns[] = { "StageA", "StageB", "StageC" };
class StageA
{
directory = "A3\Missions_F_EPA\Campaign";
// include the campaign description.ext to make it is content re-usable outside of the campaign
#include "\A3\Missions_F_EPA\Campaign\description.ext"
};
class StageB
{
directory = "A3\Missions_F_EPA\CampaignDummy";
};
class StageC
{
directory = "A3\Missions_F_EPA\CampaignDummy2";
};
};
};
// Showcase missions
class Showcases
{
displayName = "$STR_A3_CFGMISSIONS_SHOWCASES0";
briefingName = "$STR_A3_CFGMISSIONS_SHOWCASES0";
author = "$STR_A3_Bohemia_Interactive";
overviewPicture = "a3\Missions_F_Beta\data\img\Campaign_overview_CA.paa";
overviewText = "$STR_A3_CFGMISSIONS_SHOWCASES0";
class Showcase_Combined_arms
{
briefingName = "$STR_A3_Showcase_Combined_Arms_Mission_Name";
directory = "a3\Missions_F_Beta\Showcases\Showcase_Combined_arms.Stratis";
};
};
// Multiplayer missions
class MPMissions
{
class MP_COOP_m01
{
briefingName="@STR_A3_MP_COOP_m01_briefingName";
directory = "A3\missions_f\mpscenarios\MP_COOP_m01.Stratis";
};
};
// Challenges
class Challenges
{
briefingName = "$STR_A3_CHALLENGES_NAME";
overviewText = "$STR_A3_CHALLENGES_OVERVIEW";
overviewPicture = "\a3\Missions_F_Beta\data\img\Challenges_overview_CA.paa";
// Firing Drills
author = "$STR_A3_Bohemia_Interactive";
class Firing_Drills
{
briefingName = "$STR_A3_FIRING_DRILLS_NAME";
overviewText = "$STR_A3_FIRING_DRILLS_OVERVIEW";
overviewPicture = "\a3\Missions_F_Beta\data\img\FiringDrills_overview_CA.paa";
author = "$STR_A3_Bohemia_Interactive";
class SP_FD04 // Green
{
directory = "a3\Missions_F_Beta\Challenges\firing_drills\sp_fd04.stratis";
briefingName = "$STR_A3_FIRING_DRILLS_SP_FD04_NAME";
overviewText = "$STR_A3_FIRING_DRILLS_SP_FD04_OVERVIEW";
overviewPicture = "\a3\Missions_F_Beta\data\img\SP_FD04_overview_CA.paa";
author = "$STR_A3_Bohemia_Interactive";
};
};
};
};
|