Campaign Description.ext - Revision history

Lou Montana: Some wiki formatting

2023-06-10T15:13:46Z

Some wiki formatting

← Older revision		Revision as of 17:13, 10 June 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}

	A campaign's '''Description.ext''' is the entry point to load a campaign's information; the campaign title, author and overview picture, the missions tree, everything displayed from the Campaigns screen is defined in it.		A campaign's '''Description.ext''' is the entry point to load a campaign's information; the campaign title, author and overview picture, the missions tree, everything displayed from the Campaigns screen is defined in it.

Line 24:		Line 23:
	myCampaignDirectory\mission'''s'''\mission01.VR		myCampaignDirectory\mission'''s'''\mission01.VR
	myCampaignDirectory\mission'''s'''\mission02.VR		myCampaignDirectory\mission'''s'''\mission02.VR
	~~(…)~~		...

	Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.		Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.
Line 62:		Line 61:
	disableMP = 1; // since Arma 2 - if set to 1, forces the campaign as SinglePlayer		disableMP = 1; // since Arma 2 - if set to 1, forces the campaign as SinglePlayer
	enableHub = 1; // TBD - has to do with coming back to a "base"		enableHub = 1; // TBD - has to do with coming back to a "base"
	~~(…)~~		// ...
	};		};
	</syntaxhighlight>		</syntaxhighlight>
Line 77:		Line 76:
	cutscene = Chapter1Cutscene.VR; // in the missions sub-directory. A cutscene is of course optional but the parameter MUST be declared (cutscene = ;)		cutscene = Chapter1Cutscene.VR; // in the missions sub-directory. A cutscene is of course optional but the parameter MUST be declared (cutscene = ;)
	end1 = ;		end1 = ;
	~~(…)~~		// ...
	};		};
	</syntaxhighlight>		</syntaxhighlight>

Lou Montana: Add Arma 3: Multiplayer Campaign Creation link

2023-06-10T14:08:58Z

Add Arma 3: Multiplayer Campaign Creation link

← Older revision		Revision as of 16:08, 10 June 2023
Line 6:		Line 6:
	This config file can be accessed through [[campaignConfigFile]].		This config file can be accessed through [[campaignConfigFile]].

	A campaign file (''myCampaign.pbo'') should ~~need no other file~~ to work!		A campaign file (''myCampaign.pbo'') should not depend on any external resources to work but eventual mods!

	{{Feature\|important\|A wrongly formatted campaign's Description.ext can crash your game!}}		{{Feature\|important\|A wrongly formatted campaign's Description.ext can crash your game!}}

	{{Feature\|~~Informative~~\|This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].}}		{{Feature\|informative\|
			* This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].
			* For a tutorial on how to create a multiplayer campaign, see [[Arma 3: Multiplayer Campaign Creation]].
			}}


	== Campaign ~~directory structure~~ ==		== Campaign Directory Structure ==

	A campaign structure is the following:		A campaign structure is the following:
Line 24:		Line 27:

	Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.		Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.
	No files should appear in myCampaignDirectory\mission'''s''', only mission directories. Mission names do not matter nor impact the missions flow. ''Zmission.VR'' will not load after ''Amission.VR'' for example. The order is, again, defined in the '''description.ext''' file.		No files should appear in myCampaignDirectory\mission'''s''', only mission directories. Mission names do not matter nor impact the missions flow.
			''Zmission.VR'' will not load after ''Amission.VR'' for example. The order is, again, defined in the '''description.ext''' file.

	{{Feature \| ~~Informative~~ \| You may have to manually create the '''''arma3rootDir''\Campaigns''' directory.}}		{{Feature\|informative\|You may have to manually create the '''''arma3rootDir''\Campaigns''' directory.}}


	== Missions ~~flow~~ ==		== Missions Flow ==

	Missions flow structure is defined as follows:		Missions flow structure is defined as follows:
Line 99:		Line 103:
	</syntaxhighlight>		</syntaxhighlight>

	{{Feature \| ~~Informative~~ \| Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}}		{{Feature\|informative\|Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}}

	{{ArgTitle\|4\|cutscene\|{{GVI\|ofp\|1.00}}}}		{{ArgTitle\|4\|cutscene\|{{GVI\|ofp\|1.00}}}}
Line 187:		Line 191:
	</syntaxhighlight>		</syntaxhighlight>
	</spoiler>		</spoiler>
	{{Feature \| ~~Informative~~ \| FSM information found in description.fsm:		{{Feature\|informative\|
			FSM information found in description.fsm:
	'''PROJECT SPLENDID'''<br>		'''PROJECT SPLENDID'''<br>
	'''CAMPAIGN FSM'''		'''CAMPAIGN FSM'''
Line 194:		Line 199:
	* Condition "conditions" field can contain code which has to return true in order to make the mission available.<br><!--		* Condition "conditions" field can contain code which has to return true in order to make the mission available.<br><!--
	-->Other missions' classes can be used as variables.<br><!--		-->Other missions' classes can be used as variables.<br><!--
	-->Empty field returns true by default}}		-->Empty field returns true by default
			}}

	The FSM entry point (titled "A_in1") contains the following data:		The FSM entry point (titled "A_in1") contains the following data:
Line 213:		Line 219:


	== Root ~~parameters~~ ==		== Root Parameters ==

	{{Feature\|important\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}		{{Feature\|important\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}
Line 237:		Line 243:


	== Full ~~example~~ ==		== Full Example ==

			<spoiler text="See full example">
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	/*		/*
Line 292:		Line 299:
	template = C1M1.VR;		template = C1M1.VR;
	};		};

	class Chapter1_Mission2 : MissionDefault		class Chapter1_Mission2 : MissionDefault
	{		{
Line 326:		Line 334:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
			</spoiler>


	== Recommendations ==		== Recommendations ==

	If you ~~don't~~ know for sure what you are doing, follow these advices:		If you do not know for sure what you are doing, follow these advices:
	* try and make all the missions work stand-alone, then place them all in the '''Missions''' directory		* try and make all the missions work stand-alone, then place them all in the '''Missions''' directory
	* ~~don't~~ force yourself to use many chapters. ~~They~~ are useful to organise ~~properly~~ a lot of missions, but if your campaign ~~doesn't~~ have many, ~~don't~~ oversplit it.		* do not force yourself to use many chapters. Chapters are useful to organise a lot of missions, but if your campaign does not have many, do not oversplit it.
	* you can test your campaign structure by allowing file patching (in [[Arma 3: Launcher\|{{arma3}} launcher]], or ''arma3.exe -filePatching'') and placing your campaign in the ''campaign'''s''''' directory		* you can test your campaign structure by allowing file patching (in [[Arma 3: Launcher\|{{arma3}} launcher]], or ''arma3.exe -filePatching'') and placing your campaign in the ''campaign'''s''''' directory.


	[[Category:Mission Editing]]		[[Category:Mission Editing]]

Lou Montana: Some wiki formatting

2023-03-13T20:24:54Z

Some wiki formatting

← Older revision		Revision as of 22:24, 13 March 2023
Line 55:		Line 55:
	author = "Username"; // since Arma 3 - if undefined, "by unknown community author" will replace author's name		author = "Username"; // since Arma 3 - if undefined, "by unknown community author" will replace author's name
	overviewPicture = "overview.paa";		overviewPicture = "overview.paa";
	overviewText = $STR_A3_StageAOverview;		overviewText = "$STR_A3_StageAOverview";
	disableMP = 1; // since Arma 2 - if set to 1, forces the campaign as SinglePlayer		disableMP = 1; // since Arma 2 - if set to 1, forces the campaign as SinglePlayer
	enableHub = 1; // TBD - has to do with coming back to a "base"		enableHub = 1; // TBD - has to do with coming back to a "base"
Line 142:		Line 142:
	class Campaign		class Campaign
	{		{
	name = $STR_A3_CampaignName;		name = "$STR_A3_CampaignName";
	firstBattle = Missions;		firstBattle = Missions;
	disableMP = 1;		disableMP = 1;
	enableHub = 1;		enableHub = 1;

	briefingName = $STR_A3_CampaignName;		briefingName = "$STR_A3_CampaignName";
	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";
	overviewText = $STR_A3_StageAOverview;		overviewText = "$STR_A3_StageAOverview";

	class MissionDefault		class MissionDefault

Honger: missing dots etc

2022-11-06T23:57:20Z

missing dots etc

← Older revision		Revision as of 01:57, 7 November 2022
Line 24:		Line 24:

	Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.		Other files may appear at the root of myCampaignDirectory for sharing resources between missions, or storing the campaign overview image for example.
	No files should appear in myCampaignDirectory\mission'''s''' , only mission directories		No files should appear in myCampaignDirectory\mission'''s''', only mission directories. Mission names do not matter nor impact the missions flow. ''Zmission.VR'' will not load after ''Amission.VR'' for example. The order is, again, defined in the '''description.ext''' file.
	Mission names do not matter nor impact the missions flow. ''Zmission.VR'' will not load after ''Amission.VR'' for example. The order is, again, defined in the '''description.ext''' file.

	{{Feature \| Informative \| You may have to manually create the '''''arma3rootDir''\Campaigns''' directory.}}		{{Feature \| Informative \| You may have to manually create the '''''arma3rootDir''\Campaigns''' directory.}}

Lou Montana: Some wiki formatting

2022-07-25T12:29:28Z

Some wiki formatting

← Older revision		Revision as of 14:29, 25 July 2022
Line 106:		Line 106:

	{{ArgTitle\|4\|end1-6, lost\|{{GVI\|ofp\|1.00}}}}		{{ArgTitle\|4\|end1-6, lost\|{{GVI\|ofp\|1.00}}}}
	These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending (~~{{ic\|~~end1 {{=}} ;}}) will end the current chapter.		These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending (<syntaxhighlight lang="cpp" inline>end1 = ;</syntaxhighlight>) will end the current chapter.
	{{Feature\|arma3\|		{{Feature\|arma3\|
	''end1-6'' and ''lost'' are '''optional''' in ~~Arma 3~~.		''end1-6'' and ''lost'' are '''optional''' in {{arma3}}.
	Since custom ending names can be used in ~~Arma 3~~ now (~~{{ic\|~~"myCustomEnd" [[call~~]] [[~~BIS_fnc_endMission~~]]}}~~ for example)		Since custom ending names can be used in {{arma3}} now (<sqf inline>"myCustomEnd" call BIS_fnc_endMission;</sqf> for example)
	you can use your own custom name here (e.g ~~{{ic\|~~myCustomEnd {{=}} nextMission;}})}}		you can use your own custom name here (e.g <syntaxhighlight lang="cpp" inline>myCustomEnd = nextMission;</syntaxhighlight>).
			}}

	{{ArgTitle\|4\|endDefault\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|endDefault\|{{GVI\|arma3\|1.00}}}}
Line 333:		Line 334:
	* try and make all the missions work stand-alone, then place them all in the '''Missions''' directory		* try and make all the missions work stand-alone, then place them all in the '''Missions''' directory
	* don't force yourself to use many chapters. They are useful to organise properly a lot of missions, but if your campaign doesn't have many, don't oversplit it.		* don't force yourself to use many chapters. They are useful to organise properly a lot of missions, but if your campaign doesn't have many, don't oversplit it.
	* you can test your campaign structure by allowing file patching (in Arma 3 launcher, or ''arma3.exe -filePatching'') and placing your campaign in the ''campaign'''s''''' directory		* you can test your campaign structure by allowing file patching (in [[Arma 3: Launcher\|{{arma3}} launcher]], or ''arma3.exe -filePatching'') and placing your campaign in the ''campaign'''s''''' directory


	[[Category:Mission Editing]]		[[Category:Mission Editing]]

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"`

2021-11-15T22:55:57Z Text replacement - "<tt>([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}" ← Older revision Revision as of 00:55, 16 November 2021 Line 68: Line 68: Multiple chapters can exist inside Campaign block. A chapter is defined as follows: Multiple chapters can exist inside Campaign block. A chapter is defined as follows: <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> class Chapter1 // name can be customised here - it will be used as reference, in Campaign's <tt>firstBattle</tt> for example class Chapter1 // name can be customised here - it will be used as reference, in Campaign's {{hl|firstBattle}} for example { { firstMission = Mission1; // which mission should be loaded first. MUST be declared! firstMission = Mission1; // which mission should be loaded first. MUST be declared!

Lou Montana: Text replacement - "\{\{ArgTitle *\| *([^\|]+) *\| *([1-6]) *\|" to "{{ArgTitle|$2|$1|" 2021-08-08T23:43:43Z Text replacement - "\{\{ArgTitle *\| *([^\|]+) *\| *([1-6]) *\|" to "{{ArgTitle|$2|$1|" ← Older revision Revision as of 01:43, 9 August 2021 Line 102: Line 102: {{Feature | Informative | Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}} {{Feature | Informative | Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}} {{ArgTitle|cutscene|4|{{GVI|ofp|1.00}}}} {{ArgTitle|4|cutscene|{{GVI|ofp|1.00}}}} Define a cutscene mission directory that will be played before the mission. The cutscene won't appear in missions list in the campaign screen. Define a cutscene mission directory that will be played before the mission. The cutscene won't appear in missions list in the campaign screen. {{ArgTitle|end1-6, lost|4|{{GVI|ofp|1.00}}}} {{ArgTitle|4|end1-6, lost|{{GVI|ofp|1.00}}}} These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic|end1 {{=}} ;}}) will end the current chapter. These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic|end1 {{=}} ;}}) will end the current chapter. {{Feature|arma3| {{Feature|arma3| Line 112: Line 112: you can use your own custom name here (e.g {{ic|myCustomEnd {{=}} nextMission;}})}} you can use your own custom name here (e.g {{ic|myCustomEnd {{=}} nextMission;}})}} {{ArgTitle|endDefault|4|{{GVI|arma3|1.00}}}} {{ArgTitle|4|endDefault|{{GVI|arma3|1.00}}}} Fallback value in case an undefined ending is used, avoiding the game to crash. Fallback value in case an undefined ending is used, avoiding the game to crash. <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> Line 118: Line 118: </syntaxhighlight> </syntaxhighlight> {{ArgTitle|repeat|4|{{GVI|arma3|1.00}}}} {{ArgTitle|4|repeat|{{GVI|arma3|1.00}}}} ''Allow mission to repeat?'' ''Allow mission to repeat?'' <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> Line 124: Line 124: </syntaxhighlight> </syntaxhighlight> {{ArgTitle|isHub|4|{{GVI|arma3|1.00}}}} {{ArgTitle|4|isHub|{{GVI|arma3|1.00}}}} Define a mission to be hub. May have to do with '''CfgHubs'''. Define a mission to be hub. May have to do with '''CfgHubs'''. <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> Line 217: Line 217: {{Feature|important|Additional root parameters must be placed '''outside''' the [[#Campaign|Campaign class]] to be effective!}} {{Feature|important|Additional root parameters must be placed '''outside''' the [[#Campaign|Campaign class]] to be effective!}} {{ArgTitle|directory|4|{{GVI|arma3|1.00}}}} {{ArgTitle|4|directory|{{GVI|arma3|1.00}}}} Define the campaign directory, used when campaign is part of an addon. Define the campaign directory, used when campaign is part of an addon. <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> Line 223: Line 223: </syntaxhighlight> </syntaxhighlight> {{ArgTitle|filterGroup|4|{{GVI|arma3|1.00}}}} {{ArgTitle|4|filterGroup|{{GVI|arma3|1.00}}}} ''Usage unknown.'' ''Usage unknown.'' <syntaxhighlight lang="cpp"> <syntaxhighlight lang="cpp"> Line 229: Line 229: </syntaxhighlight> </syntaxhighlight> {{ArgTitle|weaponPool|4|{{GVI|ofpr|1.75}}}} {{ArgTitle|4|weaponPool|{{GVI|ofpr|1.75}}}} A campaign automatically enables [[:Category:Command Group: Weapon Pool|weapon pool]]. A campaign automatically enables [[:Category:Command Group: Weapon Pool|weapon pool]]. This parameter allows equipment transferred from one campaign mission to the next to be available during the briefing in the gear menu. This parameter allows equipment transferred from one campaign mission to the next to be available during the briefing in the gear menu. Lou Montana: Text replacement - "};" to "}; " 2021-05-25T08:57:37Z Text replacement - "};</syntaxhighlight>" to "}; </syntaxhighlight>" ← Older revision Revision as of 10:57, 25 May 2021 Line 75: Line 75: end1 = ; end1 = ; (…) (…) };</syntaxhighlight> }; </syntaxhighlight> There can be multiple chapters in a campaign, but this is optional. Campaign missions can very well be contained within a single chapter. There can be multiple chapters in a campaign, but this is optional. Campaign missions can very well be contained within a single chapter. R3vo: Text replacement - "{{Inline code|" to "{{ic|" 2021-02-27T17:09:36Z Text replacement - "{{Inline code|" to "{{ic|" ← Older revision Revision as of 19:09, 27 February 2021 Line 105: Line 105: {{ArgTitle|end1-6, lost|4|{{GVI|ofp|1.00}}}} {{ArgTitle|end1-6, lost|4|{{GVI|ofp|1.00}}}} These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{Inline code|end1 {{=}} ;}}) will end the current chapter. These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic|end1 {{=}} ;}}) will end the current chapter. {{Feature|arma3| {{Feature|arma3| ''end1-6'' and ''lost'' are '''optional''' in Arma 3. ''end1-6'' and ''lost'' are '''optional''' in Arma 3. Since custom ending names can be used in Arma 3 now ({{Inline code|"myCustomEnd" [[call]] [[BIS_fnc_endMission]]}} for example) Since custom ending names can be used in Arma 3 now ({{ic|"myCustomEnd" [[call]] [[BIS_fnc_endMission]]}} for example) you can use your own custom name here (e.g {{Inline code|myCustomEnd {{=}} nextMission;}})}} you can use your own custom name here (e.g {{ic|myCustomEnd {{=}} nextMission;}})}} {{ArgTitle|endDefault|4|{{GVI|arma3|1.00}}}} {{ArgTitle|endDefault|4|{{GVI|arma3|1.00}}}} Lou Montana: Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|" 2021-02-07T01:09:46Z Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|" ← Older revision Revision as of 03:09, 7 February 2021 Line 8: Line 8: A campaign file (''myCampaign.pbo'') should need no other file to work! A campaign file (''myCampaign.pbo'') should need no other file to work! {{Important|A wrongly formatted campaign's Description.ext can crash your game!}} {{Feature|important|A wrongly formatted campaign's Description.ext can crash your game!}} {{Feature|Informative|This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].}} {{Feature|Informative|This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].}} Line 38: Line 38: * Missions are filled with endings. * Missions are filled with endings. {{Important|Campaign class cannot contain mission classes directly!}} {{Feature|important|Campaign class cannot contain mission classes directly!}} * A campaign contains one to many chapters, and '''must''' define a parameter named '''firstBattle''' pointing to its first chapter. * A campaign contains one to many chapters, and '''must''' define a parameter named '''firstBattle''' pointing to its first chapter. Line 214: Line 214: == Root parameters == == Root parameters == {{Important|Additional root parameters must be placed '''outside''' the [[#Campaign|Campaign class]] to be effective!}} {{Feature|important|Additional root parameters must be placed '''outside''' the [[#Campaign|Campaign class]] to be effective!}} {{ArgTitle|directory|4|{{GVI|arma3|1.00}}}} {{ArgTitle|directory|4|{{GVI|arma3|1.00}}}}

Campaign Description.ext - Revision history

Lou Montana: Some wiki formatting

Lou Montana: Add Arma 3: Multiplayer Campaign Creation link

Lou Montana: Some wiki formatting

Honger: missing dots etc

Lou Montana: Some wiki formatting

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "\{\{ArgTitle \| ([^\|]+) \| ([1-6]) *\|" to "{{ArgTitle|$2|$1|"

Lou Montana: Text replacement - "};" to "}; "

R3vo: Text replacement - "{{Inline code|" to "{{ic|"

Lou Montana: Text replacement - "\{\{( )Important( )\|" to "{{$1Feature$2|$2important$2|"

← Older revision		Revision as of 00:55, 16 November 2021
Line 68:		Line 68:
	Multiple chapters can exist inside Campaign block. A chapter is defined as follows:		Multiple chapters can exist inside Campaign block. A chapter is defined as follows:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	class Chapter1 // name can be customised here - it will be used as reference, in Campaign's ~~<tt>~~firstBattle~~</tt>~~ for example		class Chapter1 // name can be customised here - it will be used as reference, in Campaign's {{hl\|firstBattle}} for example
	{		{
	firstMission = Mission1; // which mission should be loaded first. MUST be declared!		firstMission = Mission1; // which mission should be loaded first. MUST be declared!

← Older revision		Revision as of 01:43, 9 August 2021
Line 102:		Line 102:
	{{Feature \| Informative \| Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}}		{{Feature \| Informative \| Mission directories that are not declared anywhere in description.ext (such as mission or cutscene) are simply ignored.}}

	{{ArgTitle\|cutscene\|4\|{{GVI\|ofp\|1.00}}}}		{{ArgTitle\|4\|cutscene\|{{GVI\|ofp\|1.00}}}}
	Define a cutscene mission directory that will be played before the mission. The cutscene won't appear in missions list in the campaign screen.		Define a cutscene mission directory that will be played before the mission. The cutscene won't appear in missions list in the campaign screen.

	{{ArgTitle\|end1-6, lost\|4\|{{GVI\|ofp\|1.00}}}}		{{ArgTitle\|4\|end1-6, lost\|{{GVI\|ofp\|1.00}}}}
	These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic\|end1 {{=}} ;}}) will end the current chapter.		These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic\|end1 {{=}} ;}}) will end the current chapter.
	{{Feature\|arma3\|		{{Feature\|arma3\|
Line 112:		Line 112:
	you can use your own custom name here (e.g {{ic\|myCustomEnd {{=}} nextMission;}})}}		you can use your own custom name here (e.g {{ic\|myCustomEnd {{=}} nextMission;}})}}

	{{ArgTitle\|endDefault\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|endDefault\|{{GVI\|arma3\|1.00}}}}
	Fallback value in case an undefined ending is used, avoiding the game to crash.		Fallback value in case an undefined ending is used, avoiding the game to crash.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 118:		Line 118:
	</syntaxhighlight>		</syntaxhighlight>

	{{ArgTitle\|repeat\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|repeat\|{{GVI\|arma3\|1.00}}}}
	''Allow mission to repeat?''		''Allow mission to repeat?''
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 124:		Line 124:
	</syntaxhighlight>		</syntaxhighlight>

	{{ArgTitle\|isHub\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|isHub\|{{GVI\|arma3\|1.00}}}}
	Define a mission to be hub. May have to do with '''CfgHubs'''.		Define a mission to be hub. May have to do with '''CfgHubs'''.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 217:		Line 217:
	{{Feature\|important\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}		{{Feature\|important\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}

	{{ArgTitle\|directory\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|directory\|{{GVI\|arma3\|1.00}}}}
	Define the campaign directory, used when campaign is part of an addon.		Define the campaign directory, used when campaign is part of an addon.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 223:		Line 223:
	</syntaxhighlight>		</syntaxhighlight>

	{{ArgTitle\|filterGroup\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|filterGroup\|{{GVI\|arma3\|1.00}}}}
	''Usage unknown.''		''Usage unknown.''
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 229:		Line 229:
	</syntaxhighlight>		</syntaxhighlight>

	{{ArgTitle\|weaponPool\|4\|{{GVI\|ofpr\|1.75}}}}		{{ArgTitle\|4\|weaponPool\|{{GVI\|ofpr\|1.75}}}}
	A campaign automatically enables [[:Category:Command Group: Weapon Pool\|weapon pool]].		A campaign automatically enables [[:Category:Command Group: Weapon Pool\|weapon pool]].
	This parameter allows equipment transferred from one campaign mission to the next to be available during the briefing in the gear menu.		This parameter allows equipment transferred from one campaign mission to the next to be available during the briefing in the gear menu.

← Older revision		Revision as of 10:57, 25 May 2021
Line 75:		Line 75:
	end1 = ;		end1 = ;
	(…)		(…)
	};</syntaxhighlight>		};
			</syntaxhighlight>

	There can be multiple chapters in a campaign, but this is optional. Campaign missions can very well be contained within a single chapter.		There can be multiple chapters in a campaign, but this is optional. Campaign missions can very well be contained within a single chapter.

← Older revision		Revision as of 19:09, 27 February 2021
Line 105:		Line 105:

	{{ArgTitle\|end1-6, lost\|4\|{{GVI\|ofp\|1.00}}}}		{{ArgTitle\|end1-6, lost\|4\|{{GVI\|ofp\|1.00}}}}
	These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{~~Inline code~~\|end1 {{=}} ;}}) will end the current chapter.		These ''end%'' and ''lost'' parameters are used to define which mission is next. An empty ending ({{ic\|end1 {{=}} ;}}) will end the current chapter.
	{{Feature\|arma3\|		{{Feature\|arma3\|
	''end1-6'' and ''lost'' are '''optional''' in Arma 3.		''end1-6'' and ''lost'' are '''optional''' in Arma 3.
	Since custom ending names can be used in Arma 3 now ({{~~Inline code~~\|"myCustomEnd" [[call]] [[BIS_fnc_endMission]]}} for example)		Since custom ending names can be used in Arma 3 now ({{ic\|"myCustomEnd" [[call]] [[BIS_fnc_endMission]]}} for example)
	you can use your own custom name here (e.g {{~~Inline code~~\|myCustomEnd {{=}} nextMission;}})}}		you can use your own custom name here (e.g {{ic\|myCustomEnd {{=}} nextMission;}})}}

	{{ArgTitle\|endDefault\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|endDefault\|4\|{{GVI\|arma3\|1.00}}}}

← Older revision		Revision as of 03:09, 7 February 2021
Line 8:		Line 8:
	A campaign file (''myCampaign.pbo'') should need no other file to work!		A campaign file (''myCampaign.pbo'') should need no other file to work!

	{{~~Important~~\|A wrongly formatted campaign's Description.ext can crash your game!}}		{{Feature\|important\|A wrongly formatted campaign's Description.ext can crash your game!}}

	{{Feature\|Informative\|This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].}}		{{Feature\|Informative\|This page is about a campaign's Description.ext. For the mission version, please go to [[Description.ext]].}}
Line 38:		Line 38:
	* Missions are filled with endings.		* Missions are filled with endings.

	{{~~Important~~\|Campaign class cannot contain mission classes directly!}}		{{Feature\|important\|Campaign class cannot contain mission classes directly!}}

	* A campaign contains one to many chapters, and '''must''' define a parameter named '''firstBattle''' pointing to its first chapter.		* A campaign contains one to many chapters, and '''must''' define a parameter named '''firstBattle''' pointing to its first chapter.
Line 214:		Line 214:
	== Root parameters ==		== Root parameters ==

	{{~~Important~~\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}		{{Feature\|important\|Additional root parameters must be placed '''outside''' the [[#Campaign\|Campaign class]] to be effective!}}

	{{ArgTitle\|directory\|4\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|directory\|4\|{{GVI\|arma3\|1.00}}}}

Campaign Description.ext - Revision history

Lou Montana: Some wiki formatting

Lou Montana: Add Arma 3: Multiplayer Campaign Creation link

Lou Montana: Some wiki formatting

Honger: missing dots etc

Lou Montana: Some wiki formatting

Lou Montana: Text replacement - "([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"

Lou Montana: Text replacement - "\{\{ArgTitle *\| *([^\|]+) *\| *([1-6]) *\|" to "{{ArgTitle|$2|$1|"

Lou Montana: Text replacement - "};" to "}; "

R3vo: Text replacement - "{{Inline code|" to "{{ic|"

Lou Montana: Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|"

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "\{\{ArgTitle \| ([^\|]+) \| ([1-6]) *\|" to "{{ArgTitle|$2|$1|"

Lou Montana: Text replacement - "\{\{( )Important( )\|" to "{{$1Feature$2|$2important$2|"