{"name":"Arma 3: Mission Overview","title":"Arma 3: Mission Overview","type":"topic","url":"https://community.bistudio.com/wiki/Arma_3:_Mission_Overview","revid":353569,"updated":"2024-03-19T12:01:45Z","aliases":["Arma 3 Mission Overview","Mission Overview"],"markdown":"> [!NOTE]\n> For overview configuration in Operation Flashpoint, ArmA and Arma 2, see Overview.html.\n\nOverview is short summary of a mission displayed in mission selection. It's the first thing player sees from a mission and should not be underestimated; well made overview can immediately capture player's attention, while poorly made one can make him ignore your mission forever.\n\nThe overview is visible in the following menus:\n\n- **Play > Scenarios / Showcases / Challenges**\n- **Play > Campaign**\n- **Multiplayer Create Game** (only for hosts / admins)\n\n### Displayed Information\n\nThe overview consists of:\n\n- **Name**\n  - Mission name. Keep it short, because space in mission selection menu and in loading screens is limited.\n- **Author**\n  - Your name or nickname, used also in Loading Screens. Displayed as \"by <author>\".\n- **Preview picture**\n  - Must be in PAA file format.\n  - 2:1 aspect ratio (different aspect are rendered correctly as well, but won't cover the whole area).\n  - Ideally 1024x512 pixels.\n- **Description**\n  - Short and snappy summary formatted as Structured Text.\n- **Custom Description**\n  - Allows addition of custom UI elements to mission description. Serves for example for displaying score reached in challenges.\n  - Is displayed only when *overviewScript* parameter is defined in mission's class in CfgMissions. See Sample overviewScript.sqf.\n  - Works only for SP missions (namely in Showcases, Challenges and Scenarios dialogue).\n  - For custom IDCs only values higher than 10000 should be used.\n\n### Configuration\n\nTwo ways how to export a mission exists - either as mission PBO, or as addon PBO. Both are using Description.ext, but addon format also allows configuration in Config.cpp. Campaign missions are listed in Campaign Description.ext, but missions still support Description.ext.\n\nEntries defined in mission Description.ext have the largest priority and will overwrite those in Config.cpp / Campaign Description.ext\n\nSingle missions can be locked using keys. In such cases, overview image is transparent and *overviewTextLocked* is used instead of *overviewText*. This applies only to single missions, not to mission folders, campaigns or campaign missions.\n\n#### Description.ext\n\n```cpp\nbriefingName = \"The Final Countdown\";\noverviewText = \"The nuke is still out there!\";\noverviewTextLocked = \"Finish the Splendid campaign in order to unlock this mission.\";\noverviewPicture = \"overviewPicture_ca.paa\";\nauthor = \"Stranger\";\n```\n\n#### Config.cpp\n\n```cpp\nclass CfgMissions\n{\n    class Missions\n    {\n        // Mission subfolder (optional, mission can be defined straight away)\n        class MySubfolder\n        {\n            displayName = \"Comanche Missions\";\n            overviewText = \"Scenarios involving your favorite helicopter.\";\n            overviewPicture = \"\\a3\\fw_f\\data\\overviewPictureFolder_ca.paa\";\n            author = \"Stranger\";\n\n            // Mission itself\n            class MyMission\n            {\n                overviewText = \"The nuke is still out there!\";\n                overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n                overviewTextLocked = \"Finish the Splendid campaign in order to unlock this mission.\";\n                author = \"Stranger\";\n                overviewScript = \"\\FW\\scripts\\overviewScript.sqf\";\n\n                directory = \"\\FW\\MyMission.Altis\";\n            };\n        };\n    };\n    class Campaigns\n     {\n        // Campaign; its missions are defined in campaign description.ext\n        class Splendid\n        {\n            overviewText = \"SURVIVE - ADAPT - WIN\";\n            overviewPicture = \"\\a3\\missions_f\\data\\splendid_ca.paa\";\n            author = \"Bohemia Interactive\";\n\n            directory = \"\\FW\\Splendid\";\n        };\n    };\n};\n```\n\n#### Sample overviewScript.sqf\n\n```sqf\n#include \"\\A3\\ui_f\\hpp\\defineCommonGrids.inc\"\n\nparams [\"_display\", \"_missionClassname\"];\n\nprivate _challengesOverviewGroup = _display displayCtrl 2302;  // Custom UI elements should be created inside this group\n\nprivate _newControl = _display ctrlCreate [\"Rsctext\", 10001, _challengesOverviewGroup]; // IDCs higher than 10000 should be used\n_newControl ctrlSetPosition [0, 0, 21.5 * GUI_GRID_W, 3.5 * GUI_GRID_H + (0.5 * (safeZoneH - GUI_GRID_HAbs))];\n_newControl ctrlCommit 0;\n_newControl ctrlSetText \"TEST\";\n_newControl ctrlSetBackgroundColor [1,0,0,0.5];\n```\n\n#### Campaign Description.ext\n\n```cpp\nclass Campaign\n{\n    firstBattle = Beginning;\n    disableMP = 1;\n\n    briefingName = \"Splendid\";\n    author = \"Campaign author\";\n    overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n    overviewText = \"Campaign overview\";\n\n    class Beginning\n    {\n        name = \"The Beginning\";\n        cutscene = ;\n        firstMission = mission01;\n        end1 = ;\n        lost = ;\n\n        class mission01\n        {\n            briefingName = \"Mission name\";\n            author = \"Mission author\";\n            overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n            overviewText = \"Mission overview\";\n\n            template = mission01.Altis;\n        };\n    };\n};\n```","sections":[{"heading":null,"level":1,"markdown":"> [!NOTE]\n> For overview configuration in Operation Flashpoint, ArmA and Arma 2, see Overview.html.\n\nOverview is short summary of a mission displayed in mission selection. It's the first thing player sees from a mission and should not be underestimated; well made overview can immediately capture player's attention, while poorly made one can make him ignore your mission forever.\n\nThe overview is visible in the following menus:\n\n- **Play > Scenarios / Showcases / Challenges**\n- **Play > Campaign**\n- **Multiplayer Create Game** (only for hosts / admins)"},{"heading":"Displayed Information","level":3,"markdown":"The overview consists of:\n\n- **Name**\n  - Mission name. Keep it short, because space in mission selection menu and in loading screens is limited.\n- **Author**\n  - Your name or nickname, used also in Loading Screens. Displayed as \"by <author>\".\n- **Preview picture**\n  - Must be in PAA file format.\n  - 2:1 aspect ratio (different aspect are rendered correctly as well, but won't cover the whole area).\n  - Ideally 1024x512 pixels.\n- **Description**\n  - Short and snappy summary formatted as Structured Text.\n- **Custom Description**\n  - Allows addition of custom UI elements to mission description. Serves for example for displaying score reached in challenges.\n  - Is displayed only when *overviewScript* parameter is defined in mission's class in CfgMissions. See Sample overviewScript.sqf.\n  - Works only for SP missions (namely in Showcases, Challenges and Scenarios dialogue).\n  - For custom IDCs only values higher than 10000 should be used."},{"heading":"Configuration","level":3,"markdown":"Two ways how to export a mission exists - either as mission PBO, or as addon PBO. Both are using Description.ext, but addon format also allows configuration in Config.cpp. Campaign missions are listed in Campaign Description.ext, but missions still support Description.ext.\n\nEntries defined in mission Description.ext have the largest priority and will overwrite those in Config.cpp / Campaign Description.ext\n\nSingle missions can be locked using keys. In such cases, overview image is transparent and *overviewTextLocked* is used instead of *overviewText*. This applies only to single missions, not to mission folders, campaigns or campaign missions."},{"heading":"Description.ext","level":4,"markdown":"```cpp\nbriefingName = \"The Final Countdown\";\noverviewText = \"The nuke is still out there!\";\noverviewTextLocked = \"Finish the Splendid campaign in order to unlock this mission.\";\noverviewPicture = \"overviewPicture_ca.paa\";\nauthor = \"Stranger\";\n```"},{"heading":"Config.cpp","level":4,"markdown":"```cpp\nclass CfgMissions\n{\n    class Missions\n    {\n        // Mission subfolder (optional, mission can be defined straight away)\n        class MySubfolder\n        {\n            displayName = \"Comanche Missions\";\n            overviewText = \"Scenarios involving your favorite helicopter.\";\n            overviewPicture = \"\\a3\\fw_f\\data\\overviewPictureFolder_ca.paa\";\n            author = \"Stranger\";\n\n            // Mission itself\n            class MyMission\n            {\n                overviewText = \"The nuke is still out there!\";\n                overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n                overviewTextLocked = \"Finish the Splendid campaign in order to unlock this mission.\";\n                author = \"Stranger\";\n                overviewScript = \"\\FW\\scripts\\overviewScript.sqf\";\n\n                directory = \"\\FW\\MyMission.Altis\";\n            };\n        };\n    };\n    class Campaigns\n     {\n        // Campaign; its missions are defined in campaign description.ext\n        class Splendid\n        {\n            overviewText = \"SURVIVE - ADAPT - WIN\";\n            overviewPicture = \"\\a3\\missions_f\\data\\splendid_ca.paa\";\n            author = \"Bohemia Interactive\";\n\n            directory = \"\\FW\\Splendid\";\n        };\n    };\n};\n```"},{"heading":"Sample overviewScript.sqf","level":4,"markdown":"```sqf\n#include \"\\A3\\ui_f\\hpp\\defineCommonGrids.inc\"\n\nparams [\"_display\", \"_missionClassname\"];\n\nprivate _challengesOverviewGroup = _display displayCtrl 2302;  // Custom UI elements should be created inside this group\n\nprivate _newControl = _display ctrlCreate [\"Rsctext\", 10001, _challengesOverviewGroup]; // IDCs higher than 10000 should be used\n_newControl ctrlSetPosition [0, 0, 21.5 * GUI_GRID_W, 3.5 * GUI_GRID_H + (0.5 * (safeZoneH - GUI_GRID_HAbs))];\n_newControl ctrlCommit 0;\n_newControl ctrlSetText \"TEST\";\n_newControl ctrlSetBackgroundColor [1,0,0,0.5];\n```"},{"heading":"Campaign Description.ext","level":4,"markdown":"```cpp\nclass Campaign\n{\n    firstBattle = Beginning;\n    disableMP = 1;\n\n    briefingName = \"Splendid\";\n    author = \"Campaign author\";\n    overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n    overviewText = \"Campaign overview\";\n\n    class Beginning\n    {\n        name = \"The Beginning\";\n        cutscene = ;\n        firstMission = mission01;\n        end1 = ;\n        lost = ;\n\n        class mission01\n        {\n            briefingName = \"Mission name\";\n            author = \"Mission author\";\n            overviewPicture = \"\\FW\\data\\overviewPicture_ca.paa\";\n            overviewText = \"Mission overview\";\n\n            template = mission01.Altis;\n        };\n    };\n};\n```"}],"categories":["Mission Editing"],"groups":["Mission Editing"]}