2D Editor: External: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added white space)
m (Text replacement - "{{arma2}}" to "{{GameCategory|arma2|link= y}}")
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Mission Editor|External]]
[[Mission Editor]] provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs.  
[[Mission Editor]] provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs.  
{{TOC|horizontal}}


== Mission Folder ==
== Mission Folder ==
[[File:editor folder.jpg|thumb|Mission folder with the most common files]]
=== Folder Name ===
=== Folder Name ===
[[File:editor folder.jpg|thumb|Mission folder with the most common files]]
 
Missions are stored as folders with name composed of mission name set in [[Mission_Editor#Save|Save window]] and world name:
Missions are stored as folders with name composed of mission name set in [[Mission_Editor#Save|Save window]] and world name:
  <span style="color:green"><mission name></span>.<span style="color:green"><world Name></span>
  {{Color|green|missionName}}.{{Color|darkorange|worldName}}
Examples:
Examples:
  TopGun.abel
  {{Color|green|TopGun}}.{{Color|darkorange|abel}}
  SpyGame.Chernarus
  {{Color|green|SpyGame}}.{{Color|darkorange|Chernarus}}
  Domino.ProvingGrounds_PMC
  {{Color|green|Domino}}.{{Color|darkorange|ProvingGrounds_PMC}}
World name matches the class in ''CfgWorlds''
{{Color|green|This.is.Sparta}}.{{Color|darkorange|Altis}}
 
World names match classes present in ''CfgWorlds''.


=== Folder Directory ===
=== Folder Directory ===
All single player missions are located in ''Missions'' folder, multiplayer missions can be found in ''MPMissions'' folder in same directory. Path varies depending on a [[:Category:Projects|project]], see following table for specific directories:


{| class="wikitable"
You can find all missions in your [[Profile]] directory.
! Icon
! Game
! Path
|-
|[[File:ofp 1.00.gif]]
|'''[[Arma: Cold War Assault]]'''
|<code><span style="color:green">%Arma: CWA directory%</span>\Users\<span style="color:green">%player%</span>\</code>
|-
|[[File:arma 1.00.gif]]
|'''[[Arma|Arma: Armed Assault]]'''
|<code>My Documents\ArmA\<br />My Documents\ArmA Other Profiles\<span style="color:green">%player%</span>\</code>
|-
|[[File:arma2 1.00.gif]][[File:arma2oa 1.51.gif]]
|'''[[Arma 2]]'''<br />'''[[Arma 2: Operation Arrowhead]]'''
|<code>My Documents\ArmA 2\<br />My Documents\ArmA 2 Other Profiles\<span style="color:green">%player%</span>\</code>
|-
|[[File:TKOH 1.00.gif]]
|'''[[Take On Helicopters]]'''
|<code>My Documents\Take On Helicopters\<br />My Documents\Take On Helicopters Other Profiles\<span style="color:green">%player%</span>\</code>
|}
<span style="color:green">Green</span> text means variable, where you have to include either name of your profile or absolute path to an installed game.


Single player missions are located in ''Missions'' folder, multiplayer missions can be found in ''MPMissions'' folder in same directory.


=== Subfolders ===
=== Subfolders ===
Withing mission folder, you can create as many subfolders as possible. As paths in mission are relative, you can refer to such subfolder using:
 
Within the mission folder, you can create as many subfolders as desired. As paths in mission are relative, you can refer to such subfolder using:
  \subFolderName\desiredFile.sqf
  \subFolderName\desiredFile.sqf




== Files ==
== Files ==
[[File:editor folder mission.jpg|thumb|Example of mission.sqm]]
=== Mission.sqm ===
=== Mission.sqm ===
[[File:editor folder mission.jpg|thumb|Example of mission.sqm]]
The mission.sqm file is generated automatically by the [[Mission Editor]]. Any action you perform in Mission, Intro, OutroWin or OutroLoose is saved in this file.
Once you have completed your new mission, it's always good practice to check the mission.sqm for presence of unwanted addons in ''addOns'' and ''addOnsAuto'' arrays. They contain ''CfgPatches'' classes of used addons.
<pre>
class Mission
{
addOns[]=
{
"missions_ew",
"cacharacters2",
"ca_modules_functions",
"chernarus"
};
addOnsAuto[]=
{
"missions_ew",
"cacharacters2",
"ca_modules_functions",
"chernarus"
};</pre>
Apart from ''class Mission'', list of addons is present also in ''class Intro'', ''class OutroWin'' and ''class OutroLoose''.


''Main article: [[Mission.sqm]]''


{{Clear}}
[[File:editor folder description.jpg|thumb|Example of Description.ext]]
=== Description.ext ===
=== Description.ext ===
[[File:editor folder description.jpg|thumb|Example of Description.ext]]
''Main article: [[Description.ext]]''


''Main article: [[Description.ext]]''


{{Clear}}
[[File:editor folder init.jpg|thumb|Example of an *.sqf file]]
=== Scripts ===
=== Scripts ===
[[File:editor folder init.jpg|thumb|Example of *.sqf file]]
''Main article: [[Script (File)]]''


External script files are executed by filename, so they can have any filename the author chooses. There are however two special script files that are automatically executed by the game engine at specific times in the mission (if they exist):
''Main article: [[Script File]]''


[[Init.sqs |'''init.sqf/sqs''']]<br>
External script files are executed by filename, so they can have any filename the author chooses. There are however several special [[Event Scripts]] that are automatically executed by the game engine at certain times during the mission.
The mission initialisation script is automatically processed before the mission starts. This prevents "laggy" moments ingame, but might take the mission a long time to load.


'''exit.sqf/sqs'''<br>
{{Clear}}
The mission exit script is processed when the mission ends (either by end or lose type [[Mission_Editor:_Triggers|triggers]], or the [[endMission]] command).
[[File:editor folder fsm.jpg|thumb|Example of an *.fsm file]]
=== FSM ===


''Main article: [[FSM]]''


=== FSM ===
{{Clear}}
[[File:editor folder fsm.jpg|thumb|Example of *.fsm file]]
[[File:editor folder overview.jpg|thumb|Example of overview.html]]
''Main article: [[FSM]]''
=== Overview.html ===
 
''Main article: [[Overview.html]]''


The overview.html contains simple mission description and picture visible in main menu mission selection.


{{Clear}}
=== Briefing.html ===
=== Briefing.html ===
''Main article: [[Briefing.html]]''
''Main article: [[Briefing.html]]''


Line 109: Line 81:
To preview your briefing whilst in the editor, hold SHIFT while clicking 'Preview'.
To preview your briefing whilst in the editor, hold SHIFT while clicking 'Preview'.


Since [[ArmA_2|ArmA 2]], briefing.html is only used for the debriefing text. For more information see [[briefing|Arma 2 Briefing creation]].
Since {{GameCategory|arma2|link= y}}, briefing.html is only used for the debriefing text. For more information see [[briefing|Arma 2 Briefing creation]].


=== Overview.html ===
[[File:editor folder overview.jpg|thumb|Example of overview.html]]
''Main article: [[Overview.html]]''


The overview.html contains simple mission description and picture visible in main menu mission selection.
[[Category: 2D Editor]]

Latest revision as of 13:01, 19 March 2024

Mission Editor provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs.


Mission Folder

Mission folder with the most common files

Folder Name

Missions are stored as folders with name composed of mission name set in Save window and world name: 

missionName.worldName

Examples: 

TopGun.abel
SpyGame.Chernarus
Domino.ProvingGrounds_PMC
This.is.Sparta.Altis

World names match classes present in CfgWorlds.

Folder Directory

You can find all missions in your Profile directory.

Single player missions are located in Missions folder, multiplayer missions can be found in MPMissions folder in same directory.

Subfolders

Within the mission folder, you can create as many subfolders as desired. As paths in mission are relative, you can refer to such subfolder using: 

\subFolderName\desiredFile.sqf


Files

Example of mission.sqm

Mission.sqm

Main article: Mission.sqm

Example of Description.ext

Description.ext

Main article: Description.ext

Example of an *.sqf file

Scripts

Main article: Script File

External script files are executed by filename, so they can have any filename the author chooses. There are however several special Event Scripts that are automatically executed by the game engine at certain times during the mission.

Example of an *.fsm file

FSM

Main article: FSM

Example of overview.html

Overview.html

Main article: Overview.html

The overview.html contains simple mission description and picture visible in main menu mission selection.

Briefing.html

Main article: Briefing.html

File loaded automatically when the mission begins, providing mission plan and notes.

The briefing is broken into 4 main sections:

  • Notes
  • Plan
  • Objectives
  • Endings

To preview your briefing whilst in the editor, hold SHIFT while clicking 'Preview'.

Since Arma 2, briefing.html is only used for the debriefing text. For more information see Arma 2 Briefing creation.

Retrieved from "https://community.bistudio.com/wiki?title=2D_Editor:_External&oldid=353557"