Index: binaries/data/mods/mod/gui/common/modern/styles.xml
===================================================================
--- binaries/data/mods/mod/gui/common/modern/styles.xml
+++ binaries/data/mods/mod/gui/common/modern/styles.xml
@@ -30,7 +30,6 @@
scrollbar_style="ModernScrollBar"
sprite="ModernDarkBoxGoldNoTop"
sprite_selectarea="ModernDarkBoxWhite"
- sprite_heading="ModernDarkBoxGoldNoBottom"
textcolor="white"
textcolor_selected="white"
text_align="left"
Index: binaries/data/mods/public/campaigns/example.json
===================================================================
--- /dev/null
+++ binaries/data/mods/public/campaigns/example.json
@@ -0,0 +1,43 @@
+{
+ "Name": "Example Campaign",
+ "Description": "Lorem Ipsum and so on and so on",
+ "Interface": "default_menu",
+ "Levels": {
+ "Example_1": {
+ "Name": "Example 1",
+ "Map": "scenarios/serengeti.xml",
+ "MapType": "scenario",
+ "Description": "Whatever"
+ },
+ "Example_2": {
+ "Name": "Example 2",
+ "Map": "scenarios/serengeti.xml",
+ "MapType": "scenario",
+ "Description": "None",
+ "Requires": "Example_1"
+ },
+ "Example_3": {
+ "Name": "This one requires 1 and 2",
+ "Map": "scenarios/serengeti.xml",
+ "MapType": "scenario",
+ "Description": "None",
+ "Requires": "Example_1+Example_2"
+ },
+ "Example_4": {
+ "Name": "This one requires 2 or 3",
+ "Map": "scenarios/serengeti.xml",
+ "MapType": "scenario",
+ "Description": "None",
+ "Requires": "Example_2 Example_3"
+ },
+ "Example_5": {
+ "Name": "This one available only if 1 isn't completed",
+ "Map": "scenarios/serengeti.xml",
+ "MapType": "scenario",
+ "Description": "None",
+ "Requires": "!Example_1"
+ }
+ },
+ "Order": ["Example_1", "Example_2", "Example_3", "Example_4", "Example_5"],
+ "ShowUnavailable": true
+}
Index: binaries/data/mods/public/campaigns/tutorial.json
===================================================================
--- /dev/null
+++ binaries/data/mods/public/campaigns/tutorial.json
@@ -0,0 +1,23 @@
+{
+ "Name": "Tutorial",
+ "Description": "Learn how to play 0 A.D.",
+ "Image": "session/icons/mappreview/Introductory_Tutorial.png",
+ "Levels": {
+ "introduction": {
+ "Name": "Introductory Tutorial",
+ "Map": "tutorials/introductory_tutorial.xml",
+ "MapType": "scenario",
+ "Description": "This is a basic tutorial to get you started playing 0 A.D.",
+ "Preview": "session/icons/mappreview/Introductory_Tutorial.png"
+ },
+ "eco_walkthrough": {
+ "Name": "Economy Walkthrough",
+ "Map": "tutorials/starting_economy_walkthrough.xml",
+ "MapType": "scenario",
+ "Description": "This map will give a rough guide for starting the game effectively. Early in the game the most important thing is to gather resources as fast as possible so you are able to build enough troops later. Warning: This is very fast at the start, be prepared to run through the initial bit several times.",
+ "Requires": "introduction"
+ }
+ },
+ "Order": ["introduction", "eco_walkthrough"],
+ "ShowUnavailable": true
+}
Index: binaries/data/mods/public/gui/campaigns/common_scripts.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/common_scripts.xml
@@ -0,0 +1,5 @@
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/default_menu/CampaignMenu.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/CampaignMenu.js
@@ -0,0 +1,162 @@
+/**
+ * This is the main menu screen of the campaign.
+ * It shows you the currently available scenarios, scenarios you've already completed, etc.
+ * This particular variant is extremely simple and shows a list similar to Age 1's campaigns,
+ * but conceptually nothing really prevents more complex systems.
+ */
+class CampaignMenu extends AutoWatcher
+{
+ constructor(campaignRun)
+ {
+ super("render");
+
+ this.run = campaignRun;
+
+ this.selectedLevel = -1;
+ this.levelSelection = Engine.GetGUIObjectByName("levelSelection");
+ this.levelSelection.onSelectionChange = () => { this.selectedLevel = this.levelSelection.selected; };
+
+ this.levelSelection.onMouseLeftDoubleClickItem = () => this.startScenario();
+ Engine.GetGUIObjectByName('startButton').onPress = () => this.startScenario();
+ Engine.GetGUIObjectByName('backToMain').onPress = () => this.goBackToMainMenu();
+ Engine.GetGUIObjectByName('savedGamesButton').onPress = () => Engine.PushGuiPage('page_loadgame.xml', {
+ 'campaignRun': this.run.filename
+ });
+
+ this.mapCache = new MapCache();
+
+ this._ready = true;
+ }
+
+ goBackToMainMenu()
+ {
+ this.run.save();
+ Engine.SwitchGuiPage("page_pregame.xml", {});
+ }
+
+ startScenario()
+ {
+ let level = this.getSelectedLevelData();
+ if (!meetsRequirements(this.run, level))
+ return;
+ Engine.SwitchGuiPage("page_gamesetup.xml", {
+ "mapType": level.MapType,
+ "map": "maps/" + level.Map,
+ "autostart": true,
+ "campaignData": {
+ "run": this.run.filename,
+ "levelID": this.levelSelection.list_data[this.selectedLevel],
+ "data": this.run.data
+ }
+ });
+ }
+
+ getSelectedLevelData()
+ {
+ if (this.selectedLevel === -1)
+ return undefined;
+ return this.run.template.Levels[this.levelSelection.list_data[this.selectedLevel]];
+ }
+
+ shouldShowLevel(levelData)
+ {
+ if (this.run.template.ShowUnavailable)
+ return true;
+
+ return meetsRequirements(this.run, levelData);
+ }
+
+ getLevelName(levelData)
+ {
+ if (levelData.Name)
+ return translate(levelData.Name);
+ return translate(this.mapCache.getTranslatableMapName(levelData.MapType, "maps/" + levelData.Map));
+ }
+
+ getLevelDescription(levelData)
+ {
+ if (levelData.Description)
+ return translate(levelData.Description);
+ return this.mapCache.getTranslatedMapDescription(levelData.MapType, "maps/" + levelData.Map);
+
+ }
+
+ displayLevelsList()
+ {
+ let list = [];
+ for (let key in this.run.template.Levels)
+ {
+ let level = this.run.template.Levels[key];
+
+ if (!this.shouldShowLevel(level))
+ continue;
+
+ let status = "";
+ let name = this.getLevelName(level);
+ if (isCompleted(this.run, key))
+ status = translateWithContext("campaign status", "Completed");
+ else if (meetsRequirements(this.run, level))
+ status = coloredText(translateWithContext("campaign status", "Available"), "green");
+ else
+ name = coloredText(name, "gray");
+
+ list.push({ "ID": key, "name": name, "status": status });
+ }
+
+ list.sort((a, b) => this.run.template.Order.indexOf(a.ID) - this.run.template.Order.indexOf(b.ID));
+
+ list = prepareForDropdown(list);
+
+ this.levelSelection.list_name = list.name || [];
+ this.levelSelection.list_status = list.status || [];
+
+ // COList needs these changed last or crashes.
+ this.levelSelection.list = list.ID || [];
+ this.levelSelection.list_data = list.ID || [];
+ }
+
+ displayLevelDetails()
+ {
+ if (this.selectedLevel === -1)
+ {
+ Engine.GetGUIObjectByName("startButton").enabled = false;
+ Engine.GetGUIObjectByName("startButton").hidden = false;
+ return;
+ }
+
+ let level = this.getSelectedLevelData();
+
+ Engine.GetGUIObjectByName("scenarioName").caption = this.getLevelName(level);
+ Engine.GetGUIObjectByName("scenarioDesc").caption = this.getLevelDescription(level);
+ if (level.Preview)
+ Engine.GetGUIObjectByName('levelPreviewBox').sprite = "cropped:" + 400/512 + "," + 300/512 + ":" + level.Preview;
+ else
+ Engine.GetGUIObjectByName('levelPreviewBox').sprite = "cropped:" + 400/512 + "," + 300/512 + ":session/icons/mappreview/nopreview.png";
+
+ Engine.GetGUIObjectByName("startButton").enabled = meetsRequirements(this.run, level);
+ Engine.GetGUIObjectByName("startButton").hidden = false;
+ Engine.GetGUIObjectByName("loadSavedButton").hidden = true;
+ }
+
+ render()
+ {
+ Engine.GetGUIObjectByName("campaignTitle").caption = this.run.generateLabel();
+ this.displayLevelDetails();
+ this.displayLevelsList();
+ }
+}
+
+
+var g_CampaignMenu;
+
+function init(initData)
+{
+ let run;
+ try {
+ run = new CampaignRun(initData.filename).load();
+ } catch (err) {
+ error(sprintf(translate("Error loading campaign run %s: %s."), initData.filename, err));
+ Engine.SwitchGuiPage("page_pregame.xml", {});
+ }
+ g_CampaignMenu = new CampaignMenu(run);
+}
Index: binaries/data/mods/public/gui/campaigns/default_menu/CampaignMenu.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/CampaignMenu.xml
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/default_menu/endgame/endgame.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/endgame/endgame.js
@@ -0,0 +1,11 @@
+/**
+ * This is a transient page, triggered at the end of a game session,
+ * to perform custom computations on the endgame data.
+ */
+
+function init(endGameData)
+{
+ let run = CampaignRun.getCurrentRun();
+ if (endGameData.won)
+ markLevelComplete(run, endGameData.levelID);
+}
Index: binaries/data/mods/public/gui/campaigns/default_menu/endgame/endgame.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/endgame/endgame.xml
@@ -0,0 +1,6 @@
+
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/default_menu/endgame/page.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/endgame/page.xml
@@ -0,0 +1,5 @@
+
+
+ campaigns/common_scripts.xml
+ campaigns/default_menu/endgame/endgame.xml
+
Index: binaries/data/mods/public/gui/campaigns/default_menu/page.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/page.xml
@@ -0,0 +1,13 @@
+
+
+ common/modern/setup.xml
+ common/modern/styles.xml
+ common/modern/sprites.xml
+
+ common/setup.xml
+ common/sprites.xml
+ common/styles.xml
+
+ campaigns/common_scripts.xml
+ campaigns/default_menu/CampaignMenu.xml
+
Index: binaries/data/mods/public/gui/campaigns/default_menu/utils.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/default_menu/utils.js
@@ -0,0 +1,26 @@
+/**
+ * Various utilities.
+ */
+function markLevelComplete(run, levelID)
+{
+ if (!isCompleted(run, levelID))
+ {
+ if (!run.data.completedLevels)
+ run.data.completedLevels = [];
+ run.data.completedLevels.push(levelID);
+ run.save();
+ }
+}
+
+function isCompleted(run, levelID)
+{
+ return run.data.completedLevels && run.data.completedLevels.indexOf(levelID) !== -1;
+}
+
+function meetsRequirements(run, levelData)
+{
+ if (!levelData.Requires)
+ return true;
+
+ return MatchesClassList(run.data.completedLevels || [], levelData.Requires);
+}
Index: binaries/data/mods/public/gui/campaigns/load_modal/LoadModal.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/load_modal/LoadModal.js
@@ -0,0 +1,87 @@
+/**
+ * Lets you load/delete/look at existing campaign runs in your user folder.
+ */
+class LoadModal extends AutoWatcher
+{
+ constructor(campaignTemplate)
+ {
+ super("render");
+
+ // _watch so render() is called anytime currentRuns are modified.
+ this.currentRuns = _watch(CampaignRun.getCurrentRuns(), () => this.render());
+
+ Engine.GetGUIObjectByName('cancelButton').onPress = () => Engine.SwitchGuiPage("page_pregame.xml", {});
+ Engine.GetGUIObjectByName('deleteGameButton').onPress = () => this.deleteSelectedRun();
+ Engine.GetGUIObjectByName('startButton').onPress = () => this.loadCampaign();
+
+ this.noCampaignsText = Engine.GetGUIObjectByName("noCampaignsText");
+
+ this.selectedRun = -1;
+ this.runSelection = Engine.GetGUIObjectByName("runSelection");
+ this.runSelection.onSelectionChange = () => {
+ this.selectedRun = this.runSelection.selected;
+ if (this.selectedRun === -1)
+ Engine.GetGUIObjectByName('runDescription').caption = "";
+ else
+ Engine.GetGUIObjectByName('runDescription').caption = this.currentRuns[this.selectedRun].generateLabel();
+ };
+
+ this.runSelection.onMouseLeftDoubleClickItem = () => this.loadCampaign();
+
+ this._ready = true;
+ }
+
+ loadCampaign()
+ {
+ let filename = this.currentRuns[this.selectedRun].filename;
+ let run = new CampaignRun(filename)
+ .load()
+ .setCurrent();
+
+ Engine.SwitchGuiPage(run.getMenuPath(), {
+ "filename": filename
+ });
+ }
+
+ deleteSelectedRun()
+ {
+ if (this.selectedRun === -1)
+ return;
+
+ let run = this.currentRuns[this.selectedRun];
+
+ messageBox(
+ 400, 200,
+ sprintf(translate("Are you sure you want to delete run %s? This cannot be undone."), run.generateLabel()),
+ translate("Confirmation"),
+ [translate("Yes"), translate("No")],
+ [() => {
+ run.destroy();
+ this.currentRuns.splice(this.selectedRun, 1);
+ this.selectedRun = -1;
+ }, null]
+ );
+ }
+
+ displayCurrentRuns()
+ {
+ this.runSelection.list = this.currentRuns.map(run => run.generateLabel());
+ this.runSelection.list_data = this.currentRuns.map(run => run.filename);
+ }
+
+ render()
+ {
+ this.noCampaignsText.hidden = !!this.currentRuns.length;
+ Engine.GetGUIObjectByName('deleteGameButton').enabled = this.selectedRun !== -1;
+ Engine.GetGUIObjectByName('startButton').enabled = this.selectedRun !== -1;
+ this.displayCurrentRuns();
+ }
+}
+
+
+var g_LoadModal;
+
+function init()
+{
+ g_LoadModal = new LoadModal();
+}
Index: binaries/data/mods/public/gui/campaigns/load_modal/LoadModal.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/load_modal/LoadModal.xml
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/load_modal/page.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/load_modal/page.xml
@@ -0,0 +1,13 @@
+
+
+ common/modern/setup.xml
+ common/modern/styles.xml
+ common/modern/sprites.xml
+
+ common/setup.xml
+ common/sprites.xml
+ common/styles.xml
+
+ campaigns/common_scripts.xml
+ campaigns/load_modal/LoadModal.xml
+
Index: binaries/data/mods/public/gui/campaigns/new_modal/NewCampaignModal.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/new_modal/NewCampaignModal.js
@@ -0,0 +1,42 @@
+/**
+ * Modal screen that pops up when you start a new campaign from the setup screen.
+ * asking you to name it.
+ * Will then create the file with the according name and start everything up.
+ */
+class NewCampaignModal
+{
+ constructor(campaignTemplate)
+ {
+ this.template = campaignTemplate;
+
+ Engine.GetGUIObjectByName('cancelButton').onPress = () => Engine.PopGuiPage();
+ Engine.GetGUIObjectByName('startButton').onPress = () => this.createAndStartCampaign();
+ Engine.GetGUIObjectByName('runDescription').caption = this.template.Name;
+ Engine.GetGUIObjectByName('runDescription').onTextEdit = () => {
+ Engine.GetGUIObjectByName('startButton').enabled = Engine.GetGUIObjectByName('runDescription').caption.length > 0;
+ };
+ Engine.GetGUIObjectByName('runDescription').focus();
+ }
+
+ createAndStartCampaign()
+ {
+ let filename = this.template.identifier + "_" + Date.now() + "_" + Math.floor(Math.random()*100000);
+ let run = new CampaignRun(filename)
+ .setTemplate(this.template)
+ .setMeta(Engine.GetGUIObjectByName('runDescription').caption)
+ .save()
+ .setCurrent();
+
+ Engine.SwitchGuiPage(run.getMenuPath(), {
+ "filename": filename
+ });
+ }
+}
+
+
+var g_NewCampaignModal;
+
+function init(campaign_template_data)
+{
+ g_NewCampaignModal = new NewCampaignModal(campaign_template_data);
+}
Index: binaries/data/mods/public/gui/campaigns/new_modal/NewCampaignModal.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/new_modal/NewCampaignModal.xml
@@ -0,0 +1,31 @@
+
+
+
+
+
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/new_modal/page.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/new_modal/page.xml
@@ -0,0 +1,14 @@
+
+
+
+ common/modern/setup.xml
+ common/modern/styles.xml
+ common/modern/sprites.xml
+
+ common/setup.xml
+ common/sprites.xml
+ common/styles.xml
+
+ campaigns/common_scripts.xml
+ campaigns/new_modal/NewCampaignModal.xml
+
Index: binaries/data/mods/public/gui/campaigns/setup/CampaignSetupPage.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/setup/CampaignSetupPage.js
@@ -0,0 +1,71 @@
+/**
+ * The campaign setup page shows you the list of available campaigns,
+ * some information about them, and lets you start a new one.
+ */
+class CampaignSetupPage extends AutoWatcher
+{
+ constructor()
+ {
+ super("render");
+
+ this.selectedIndex = -1;
+ this.templates = CampaignTemplate.getAvailableTemplates();
+
+ Engine.GetGUIObjectByName("mainMenuButton").onPress = () => Engine.SwitchGuiPage("page_pregame.xml");
+ Engine.GetGUIObjectByName("startCampButton").onPress = () => Engine.PushGuiPage("campaigns/new_modal/page.xml", this.selectedTemplate);
+
+ this.campaignSelection = Engine.GetGUIObjectByName("campaignSelection");
+ this.campaignSelection.onMouseLeftDoubleClickItem = () => {
+ if (this.selectedIndex === -1)
+ return;
+ Engine.PushGuiPage("campaigns/new_modal/page.xml", this.selectedTemplate);
+ };
+ this.campaignSelection.onSelectionChange = () => {
+ this.selectedIndex = this.campaignSelection.selected;
+ if (this.selectedIndex !== -1)
+ this.selectedTemplate = this.templates[this.selectedIndex];
+ else
+ this.selectedTemplate = null;
+ };
+
+ this._ready = true;
+ }
+
+ displayCampaignDetails()
+ {
+ Engine.GetGUIObjectByName("startCampButton").enabled = this.selectedIndex !== -1;
+
+ if (!this.selectedTemplate)
+ {
+ Engine.GetGUIObjectByName("campaignTitle").caption = translate("No campaign selected.");
+ Engine.GetGUIObjectByName("campaignDesc").caption = "";
+ Engine.GetGUIObjectByName("campaignImage").sprite = "cropped:" + 400/512 + "," + 300/512 + ":session/icons/mappreview/nopreview.png";
+ return;
+ }
+
+ Engine.GetGUIObjectByName("campaignTitle").caption = translate(this.selectedTemplate.Name);
+ Engine.GetGUIObjectByName("campaignDesc").caption = translate(this.selectedTemplate.Description);
+ if ('Image' in this.selectedTemplate)
+ Engine.GetGUIObjectByName("campaignImage").sprite = "stretched:" + this.selectedTemplate.Image;
+ else
+ Engine.GetGUIObjectByName("campaignImage").sprite = "cropped:" + 400/512 + "," + 300/512 + ":session/icons/mappreview/nopreview.png";
+ }
+
+ render()
+ {
+ this.displayCampaignDetails();
+
+ Engine.GetGUIObjectByName("campaignSelection").list_name = this.templates.map((camp) => camp.Name);
+ // COList needs these changed last or crashes.
+ Engine.GetGUIObjectByName("campaignSelection").list = this.templates.map((camp) => camp.identifier) || [];
+ Engine.GetGUIObjectByName("campaignSelection").list_data = this.templates.map((camp) => camp.identifier) || [];
+ }
+}
+
+
+var g_CampaignSetupPage;
+
+function init()
+{
+ g_CampaignSetupPage = new CampaignSetupPage();
+}
Index: binaries/data/mods/public/gui/campaigns/setup/CampaignSetupPage.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/setup/CampaignSetupPage.xml
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+
+
Index: binaries/data/mods/public/gui/campaigns/setup/page.xml
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/campaigns/setup/page.xml
@@ -0,0 +1,13 @@
+
+
+ common/modern/setup.xml
+ common/modern/styles.xml
+ common/modern/sprites.xml
+
+ common/setup.xml
+ common/sprites.xml
+ common/styles.xml
+
+ campaigns/common_scripts.xml
+ campaigns/setup/CampaignSetupPage.xml
+
Index: binaries/data/mods/public/gui/common/campaigns/CampaignRun.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/common/campaigns/CampaignRun.js
@@ -0,0 +1,138 @@
+// Cached run for CampaignRun.getCurrentRun()
+// TODO: Move this to a static member once we upgrade to SM75
+var g_CurrentCampaignRun;
+
+/**
+ * A campaign "Run" saves metadata on a campaign progession.
+ * It is equivalent to a saved game for a game.
+ * It is named a "run" in an attempt to disambiguate with saved games from campaign runs,
+ * campaign templates, and the actual concept of a campaign at large.
+ */
+class CampaignRun
+{
+ static getCurrentRuns()
+ {
+ let names = Engine.ListDirectoryFiles("saves/campaigns/", "*.0adcampaign", false);
+ return names.map(path => {
+ let filename = path.replace("saves/campaigns/", "").replace(".0adcampaign", "");
+ try
+ {
+ return new CampaignRun(filename).load();
+ }
+ catch(err) {}
+ }).filter(x => !!x);
+ }
+
+ static getCurrentRun()
+ {
+ let current = Engine.ConfigDB_GetValue("user", "currentcampaign");
+ if (g_CurrentCampaignRun && g_CurrentCampaignRun.ID == current)
+ return g_CurrentCampaignRun.run;
+ try
+ {
+ let run = new CampaignRun(current).load();
+ g_CurrentCampaignRun = {
+ "run": run,
+ "ID": current
+ };
+ return run;
+ }
+ catch(error)
+ {
+ return undefined;
+ }
+ }
+
+ constructor(name = "")
+ {
+ this.filename = name;
+ // Metadata on the run, such as its description.
+ this.meta = {};
+ // 'User' data
+ this.data = {};
+ // ID of the campaign templates.
+ this.template = null;
+ }
+
+ setData(data)
+ {
+ if (!data)
+ {
+ warn("Invalid campaign scenario end data. Nothing will be saved.");
+ return this;
+ }
+
+ this.data = data;
+ this.save();
+ return this;
+ }
+
+ setTemplate(template)
+ {
+ this.template = template;
+ this.save();
+ return this;
+ }
+
+ setMeta(description)
+ {
+ this.meta.userDescription = description;
+ this.save();
+ return this;
+ }
+
+ setCurrent()
+ {
+ Engine.ConfigDB_CreateValue("user", "currentcampaign", this.filename);
+ Engine.ConfigDB_WriteValueToFile("user", "currentcampaign", this.filename, "config/user.cfg");
+ return this;
+ }
+
+ getMenuPath()
+ {
+ return "campaigns/" + this.template.interface + "/page.xml";
+ }
+
+ getEndGamePath()
+ {
+ return "campaigns/" + this.template.interface + "/endgame/page.xml";
+ }
+
+ generateLabel()
+ {
+ return sprintf(translate("%(userDesc)s - %(templateName)s"), {
+ "userDesc": this.meta.userDescription,
+ "templateName": this.template.Name
+ });
+ }
+
+
+ load()
+ {
+ if (!Engine.FileExists("saves/campaigns/" + this.filename + ".0adcampaign"))
+ throw new Error("Campaign file does not exist");
+ let data = Engine.ReadJSONFile("saves/campaigns/" + this.filename + ".0adcampaign");
+ this.data = data.data;
+ this.meta = data.meta;
+ this.template = CampaignTemplate.getTemplate(data.template_identifier);
+ if (!this.template)
+ throw new Error("Campaign template " + data.template_identifier + " does not exist (perhaps it comes from a mod?)");
+ return this;
+ }
+
+ save()
+ {
+ let data = {
+ "data": this.data,
+ "meta": this.meta,
+ "template_identifier": this.template.identifier
+ };
+ Engine.WriteJSONFile("saves/campaigns/" + this.filename + ".0adcampaign", data);
+ return this;
+ }
+
+ destroy()
+ {
+ Engine.DeleteCampaignSave("saves/campaigns/" + this.filename + ".0adcampaign");
+ }
+}
Index: binaries/data/mods/public/gui/common/campaigns/CampaignTemplate.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/common/campaigns/CampaignTemplate.js
@@ -0,0 +1,54 @@
+// TODO: replace this with a static member once we hit SM 75.
+var g_CachedTemplates;
+
+class CampaignTemplate
+{
+ /**
+ * @returns a dictionary of campaign templates, as [ { 'identifier': id, 'data': data }, ... ]
+ */
+ static getAvailableTemplates()
+ {
+ if (g_CachedTemplates)
+ return g_CachedTemplates;
+
+ let campaigns = Engine.ListDirectoryFiles("campaigns/", "*.json", false);
+
+ g_CachedTemplates = [];
+
+ for (let filename of campaigns)
+ // Use file name as identifier to guarantee unicity.
+ g_CachedTemplates.push(new CampaignTemplate(filename.slice("campaigns/".length, -".json".length)));
+
+ return g_CachedTemplates;
+ }
+
+ static getTemplate(identifier)
+ {
+ if (!g_CachedTemplates)
+ CampaignTemplate.getAvailableTemplates();
+ let temp = g_CachedTemplates.filter(t => t.identifier == identifier);
+ if (!temp.length)
+ return null;
+ return temp[0];
+ }
+
+ constructor(identifier)
+ {
+ Object.assign(this, Engine.ReadJSONFile("campaigns/" + identifier + ".json"));
+
+ this.identifier = identifier;
+
+ if (this.Interface)
+ this.interface = this.Interface;
+ else
+ this.interface = "default_menu";
+
+ if (!this.isValid())
+ throw ("Campaign template " + this.identifier + ".json is not a valid campaign template.");
+ }
+
+ isValid()
+ {
+ return this.Name;
+ }
+}
Index: binaries/data/mods/public/gui/common/campaigns/utils.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/common/campaigns/utils.js
@@ -0,0 +1,38 @@
+/**
+ * Wrap object in a proxy, that calls callback
+ * anytime a property is set, passing the property name as parameter.
+ * Note that this doesn't modify any variable that pointer towards object,
+ * so this is _not_ equivalent to replacing the target object with a proxy.
+ */
+function _watch(object, callback)
+{
+ return new Proxy(object, {
+ "get": (obj, key) => {
+ return obj[key];
+ },
+ "set": (obj, key, value) => {
+ obj[key] = value;
+ callback(key);
+ return true;
+ }
+ });
+}
+
+/**
+ * Inherit from AutoWatcher to make 'this' a proxy object that
+ * watches for its own property changes and calls the method given
+ * (takes a string because 'this' is unavailable when calling 'super').
+ * This can be used to e.g. automatically call a rendering function
+ * if a property is changed.
+ * Using inheritance is necessary because 'this' is immutable,
+ * and isn't defined in the class constructor _unless_ super() is called.
+ * (thus you can't do something like this = new Proxy(this) at the end).
+ */
+class AutoWatcher
+{
+ constructor(method_name)
+ {
+ this._ready = false;
+ return _watch(this, () => this._ready && this[method_name]());
+ }
+}
Index: binaries/data/mods/public/gui/gamesetup/Controls/GameSettingsControl.js
===================================================================
--- binaries/data/mods/public/gui/gamesetup/Controls/GameSettingsControl.js
+++ binaries/data/mods/public/gui/gamesetup/Controls/GameSettingsControl.js
@@ -104,20 +104,18 @@
{
if (initData && initData.map && initData.mapType)
{
- Object.defineProperty(this, "autostart", {
- "value": true,
- "writable": false,
- "configurable": false
- });
+ if (initData.autostart)
+ Object.defineProperty(this, "autostart", {
+ "value": true,
+ "writable": false,
+ "configurable": false
+ });
// TODO: Fix g_GameAttributes, g_GameAttributes.settings,
// g_GameAttributes.settings.PlayerData object references and
// copy over each attribute individually when receiving
// settings from the server or the local file.
- g_GameAttributes = {
- "mapType": initData.mapType,
- "map": initData.map
- };
+ g_GameAttributes = initData;
this.updateGameAttributes();
// Don't launchGame before all Load handlers finished
Index: binaries/data/mods/public/gui/loadgame/SavegameList.js
===================================================================
--- binaries/data/mods/public/gui/loadgame/SavegameList.js
+++ binaries/data/mods/public/gui/loadgame/SavegameList.js
@@ -8,11 +8,15 @@
*/
class SavegameList
{
- constructor()
+ constructor(campaignRun)
{
this.savedGamesMetadata = [];
this.selectionChangeHandlers = [];
+ // If not null, only show games for the following campaign run
+ // (campaign save-games are not shown by default).
+ this.campaignRun = campaignRun;
+
this.gameSelection = Engine.GetGUIObjectByName("gameSelection");
this.gameSelectionFeedback = Engine.GetGUIObjectByName("gameSelectionFeedback");
this.confirmButton = Engine.GetGUIObjectByName("confirmButton");
@@ -67,7 +71,13 @@
let engineInfo = Engine.GetEngineInfo();
if (this.compatibilityFilter.checked)
- savedGames = savedGames.filter(game => this.isCompatibleSavegame(game.metadata, engineInfo));
+ savedGames = savedGames.filter(game => {
+ return this.isCompatibleSavegame(game.metadata, engineInfo) &&
+ this.campaignFilter(game.metadata, this.campaignRun);
+ });
+ else if (this.campaignRun)
+ savedGames = savedGames.filter(game => this.campaignFilter(game.metadata, this.campaignRun));
+
this.gameSelection.enabled = !!savedGames.length;
this.gameSelectionFeedback.hidden = !!savedGames.length;
@@ -114,7 +124,8 @@
});
let list = this.savedGamesMetadata.map(metadata => {
- let isCompatible = this.isCompatibleSavegame(metadata, engineInfo);
+ let isCompatible = this.isCompatibleSavegame(metadata, engineInfo) &&
+ this.campaignFilter(metadata, this.campaignRun);
return {
"date": this.generateSavegameDateString(metadata, engineInfo),
"mapName": compatibilityColor(translate(metadata.initAttributes.settings.Name), isCompatible),
@@ -144,6 +155,15 @@
this.gameSelection.selected = this.savedGamesMetadata.length - 1;
}
+ campaignFilter(metadata, campaignRun)
+ {
+ if (!campaignRun)
+ return !metadata.initAttributes.campaignData;
+ if (metadata.initAttributes.campaignData)
+ return metadata.initAttributes.campaignData.run == campaignRun;
+ return false;
+ }
+
isCompatibleSavegame(metadata, engineInfo)
{
return engineInfo &&
Index: binaries/data/mods/public/gui/loadgame/SavegamePage.js
===================================================================
--- binaries/data/mods/public/gui/loadgame/SavegamePage.js
+++ binaries/data/mods/public/gui/loadgame/SavegamePage.js
@@ -1,14 +1,3 @@
-/**
- * This class architecture is an example of how to use classes
- * to encapsulate and to avoid fragmentation and globals.
- */
-var g_SavegamePage;
-
-function init(data)
-{
- g_SavegamePage = new SavegamePage(data);
-}
-
/**
* This class is responsible for loading the affected GUI control classes,
* and setting them up to communicate with each other.
@@ -17,7 +6,7 @@
{
constructor(data)
{
- this.savegameList = new SavegameList();
+ this.savegameList = new SavegameList(data && data.campaignRun || null);
this.savegameDetails = new SavegameDetails();
this.savegameList.registerSelectionChangeHandler(this.savegameDetails);
@@ -43,3 +32,10 @@
Engine.GetGUIObjectByName("cancel").onPress = () => { Engine.PopGuiPage(); };
}
}
+
+var g_SavegamePage;
+
+function init(data)
+{
+ g_SavegamePage = new SavegamePage(data);
+}
Index: binaries/data/mods/public/gui/pregame/MainMenuItemHandler.js
===================================================================
--- binaries/data/mods/public/gui/pregame/MainMenuItemHandler.js
+++ binaries/data/mods/public/gui/pregame/MainMenuItemHandler.js
@@ -38,7 +38,7 @@
0, 0, 100, 0);
button.caption = item.caption;
button.tooltip = item.tooltip;
- button.enabled = item.enabled === undefined || item.enabled;
+ button.enabled = item.enabled === undefined || item.enabled();
button.onPress = this.pressButton.bind(this, item, i);
button.hidden = false;
});
Index: binaries/data/mods/public/gui/pregame/MainMenuItems.js
===================================================================
--- binaries/data/mods/public/gui/pregame/MainMenuItems.js
+++ binaries/data/mods/public/gui/pregame/MainMenuItems.js
@@ -15,6 +15,7 @@
"tooltip": translate("Start the economic tutorial."),
"onPress": () => {
Engine.SwitchGuiPage("page_gamesetup.xml", {
+ "autostart": true,
"mapType": "scenario",
"map": "maps/tutorials/starting_economy_walkthrough"
});
@@ -46,6 +47,16 @@
}
]
},
+ {
+ "caption": translate("Continue Campaign"),
+ "tooltip": translate("Relive history through historical military campaigns."),
+ "onPress": () => {
+ Engine.SwitchGuiPage(CampaignRun.getCurrentRun().getMenuPath(), {
+ "filename": CampaignRun.getCurrentRun().filename
+ });
+ },
+ "enabled": () => !!CampaignRun.getCurrentRun()
+ },
{
"caption": translate("Single-player"),
"tooltip": translate("Start, load, or replay a single-player game."),
@@ -57,11 +68,6 @@
Engine.SwitchGuiPage("page_gamesetup.xml");
}
},
- {
- "caption": translate("Campaigns"),
- "tooltip": translate("Relive history through historical military campaigns. \\[NOT YET IMPLEMENTED]"),
- "enabled": false
- },
{
"caption": translate("Load Game"),
"tooltip": translate("Load a saved game."),
@@ -69,6 +75,33 @@
Engine.PushGuiPage("page_loadgame.xml");
}
},
+ {
+ "caption": translate("Continue Campaign"),
+ "tooltip": translate("Relive history through historical military campaigns."),
+ "onPress": () => {
+ Engine.SwitchGuiPage(CampaignRun.getCurrentRun().getMenuPath(), {
+ "filename": CampaignRun.getCurrentRun().filename
+ });
+ },
+ "enabled": () => !!CampaignRun.getCurrentRun()
+ },
+ {
+ "caption": translate("New Campaign"),
+ "tooltip": translate("Relive history through historical military campaigns."),
+ "onPress": () => {
+ Engine.SwitchGuiPage("campaigns/setup/page.xml");
+ }
+ },
+ {
+ "caption": translate("Load Campaign"),
+ "tooltip": translate("Relive history through historical military campaigns."),
+ "onPress": () => {
+ // Switch instead of push, otherwise the 'continue'
+ // button might remain enabled.
+ // TODO: find a better solution.
+ Engine.SwitchGuiPage("campaigns/load_modal/page.xml");
+ }
+ },
{
"caption": translate("Replays"),
"tooltip": translate("Playback previous games."),
@@ -112,7 +145,7 @@
"tooltip":
colorizeHotkey(translate("%(hotkey)s: Launch the multiplayer lobby to join and host publicly visible games and chat with other players."), "lobby") +
(Engine.StartXmppClient ? "" : translate("Launch the multiplayer lobby. \\[DISABLED BY BUILD]")),
- "enabled": !!Engine.StartXmppClient,
+ "enabled": () => !!Engine.StartXmppClient,
"hotkey": "lobby",
"onPress": () => {
if (Engine.StartXmppClient)
Index: binaries/data/mods/public/gui/pregame/mainmenu.xml
===================================================================
--- binaries/data/mods/public/gui/pregame/mainmenu.xml
+++ binaries/data/mods/public/gui/pregame/mainmenu.xml
@@ -2,6 +2,7 @@
+
Index: binaries/data/mods/public/gui/session/MenuButtons.js
===================================================================
--- binaries/data/mods/public/gui/session/MenuButtons.js
+++ binaries/data/mods/public/gui/session/MenuButtons.js
@@ -61,7 +61,10 @@
Engine.PushGuiPage(
"page_loadgame.xml",
- { "savedGameData": getSavedGameData() },
+ {
+ "savedGameData": getSavedGameData(),
+ "campaignRun": g_CampaignSession ? g_CampaignSession.run.filename : null
+ },
resumeGame);
}
};
Index: binaries/data/mods/public/gui/session/campaigns/CampaignSession.js
===================================================================
--- /dev/null
+++ binaries/data/mods/public/gui/session/campaigns/CampaignSession.js
@@ -0,0 +1,42 @@
+class CampaignSession
+{
+ constructor(data)
+ {
+ this.run = new CampaignRun(data.run).load();
+ this.levelID = data.levelID;
+ registerPlayersFinishedHandler(this.onFinish.bind(this));
+ this.endGameData = {
+ "levelID": data.levelID,
+ "won": false,
+ "custom": {}
+ };
+ }
+
+ onFinish(players, won)
+ {
+ let playerID = Engine.GetPlayerID();
+ if (players.indexOf(playerID) === -1)
+ return;
+
+ this.endGameData.custom = Engine.GuiInterfaceCall("GetCampaignGameEndData", {
+ "player": playerID
+ });
+ this.endGameData.won = won;
+
+ // Run the endgame script.
+ Engine.PushGuiPage(this.getEndGame(), this.endGameData);
+ Engine.PopGuiPage();
+ }
+
+ getMenu()
+ {
+ return this.run.getMenuPath();
+ }
+
+ getEndGame()
+ {
+ return this.run.getEndGamePath();
+ }
+}
+
+var g_CampaignSession;
Index: binaries/data/mods/public/gui/session/session.js
===================================================================
--- binaries/data/mods/public/gui/session/session.js
+++ binaries/data/mods/public/gui/session/session.js
@@ -265,6 +265,9 @@
restoreSavedGameData(initData.savedGUIData);
}
+ if (g_GameAttributes.campaignData)
+ g_CampaignSession = new CampaignSession(g_GameAttributes.campaignData);
+
let mapCache = new MapCache();
g_Cheats = new Cheats();
g_DiplomacyColors = new DiplomacyColors();
@@ -522,7 +525,7 @@
if (g_IsController && Engine.HasXmppClient())
Engine.SendUnregisterGame();
- Engine.SwitchGuiPage("page_summary.xml", {
+ let summaryData = {
"sim": simData,
"gui": {
"dialog": false,
@@ -532,7 +535,21 @@
"replayDirectory": !g_HasRejoined && replayDirectory,
"replaySelectionData": g_ReplaySelectionData
}
- });
+ };
+
+ if (g_GameAttributes.campaignData)
+ {
+ let menu = g_CampaignSession.getMenu();
+ if (g_GameAttributes.campaignData.skipSummary)
+ {
+ Engine.SwitchGuiPage(menu);
+ return;
+ }
+ summaryData.campaignData = { "filename": g_GameAttributes.campaignData.run };
+ summaryData.nextPage = menu;
+ }
+
+ Engine.SwitchGuiPage("page_summary.xml", summaryData);
}
// Return some data that we'll use when hotloading this file after changes
Index: binaries/data/mods/public/gui/session/session.xml
===================================================================
--- binaries/data/mods/public/gui/session/session.xml
+++ binaries/data/mods/public/gui/session/session.xml
@@ -3,7 +3,9 @@
+
+
Index: binaries/data/mods/public/gui/summary/summary.js
===================================================================
--- binaries/data/mods/public/gui/summary/summary.js
+++ binaries/data/mods/public/gui/summary/summary.js
@@ -464,6 +464,8 @@
"replaySelectionData": g_GameData.gui.replaySelectionData,
"summarySelection": summarySelection
});
+ else if (g_GameData.campaignData)
+ Engine.SwitchGuiPage(g_GameData.nextPage, g_GameData.campaignData);
else
Engine.SwitchGuiPage("page_pregame.xml");
}
Index: binaries/data/mods/public/l10n/.tx/config
===================================================================
--- binaries/data/mods/public/l10n/.tx/config
+++ binaries/data/mods/public/l10n/.tx/config
@@ -31,6 +31,11 @@
source_file = public-gui-other.pot
source_lang = en
+[0ad.public-gui-campaigns]
+file_filter = .public-gui-campaigns.po
+source_file = public-gui-campaigns.pot
+source_lang = en
+
[0ad.public-gui-userreport]
file_filter = .public-gui-userreport.po
source_file = public-gui-userreport.pot
Index: binaries/data/mods/public/l10n/messages.json
===================================================================
--- binaries/data/mods/public/l10n/messages.json
+++ binaries/data/mods/public/l10n/messages.json
@@ -240,6 +240,71 @@
}
]
},
+ {
+ "output": "public-gui-campaigns.pot",
+ "inputRoot": "..",
+ "project": "0 A.D. — Empires Ascendant",
+ "copyrightHolder": "Wildfire Games",
+ "rules": [
+ {
+ "extractor": "javascript",
+ "filemasks": [
+ "gui/campaigns/**.js",
+ "gui/campaigns/default_menu/**.js",
+ "gui/campaigns/load_modal/**.js",
+ "gui/campaigns/new_modal/**.js",
+ "gui/campaigns/setup/**.js",
+ "gui/common/campaigns/**.js"
+ ],
+ "options": {
+ "format": "javascript-format",
+ "keywords": {
+ "translate": [1],
+ "translatePlural": [1, 2],
+ "translateWithContext": [[1], 2],
+ "translatePluralWithContext": [[1], 2, 3],
+ "markForTranslation": [1],
+ "markForTranslationWithContext": [[1], 2],
+ "markForPluralTranslation": [1, 2]
+ },
+ "commentTags": [
+ "Translation:"
+ ]
+ }
+ },
+ {
+ "extractor": "xml",
+ "filemasks": [
+ "gui/campaigns/**.xml",
+ "gui/campaigns/default_menu/**.xml",
+ "gui/campaigns/load_modal/**.xml",
+ "gui/campaigns/new_modal/**.xml",
+ "gui/campaigns/setup/**.xml",
+ "gui/common/campaigns/**.xml"
+ ],
+ "options": {
+ "keywords": {
+ "translatableAttribute": {
+ "locationAttributes": ["id"]
+ },
+ "translate": {}
+ }
+ }
+ },
+ {
+ "extractor": "json",
+ "filemasks": [
+ "campaigns/**.json"
+ ],
+ "options": {
+ "keywords": [
+ "Name",
+ "Description"
+ ]
+ }
+ }
+ ]
+ },
{
"output": "public-gui-other.pot",
"inputRoot": "..",
Index: binaries/data/mods/public/maps/tutorials/introductory_tutorial.js
===================================================================
--- binaries/data/mods/public/maps/tutorials/introductory_tutorial.js
+++ binaries/data/mods/public/maps/tutorials/introductory_tutorial.js
@@ -6,6 +6,10 @@
"instructions": markForTranslation("Left-click on a female citizen and then right-click on a berry bush to make that female citizen gather food. Female citizens gather vegetables faster than other units."),
"OnPlayerCommand": function(msg)
{
+ let cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
+ cmpEndGameManager.MarkPlayerAndAlliesAsWon(1, () => "", () => "");
+ this.NextGoal();
+
if (msg.cmd.type == "gather" && msg.cmd.target &&
TriggerHelper.GetResourceType(msg.cmd.target).specific == "fruit")
this.NextGoal();
@@ -424,6 +428,13 @@
}
};
+Trigger.prototype.OnCampaignGameEnd = function()
+{
+ return {
+ "somearbitrarydata": 4
+ };
+};
+
{
let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
cmpTrigger.playerID = 1;
Index: binaries/data/mods/public/maps/tutorials/introductory_tutorial.xml
===================================================================
--- binaries/data/mods/public/maps/tutorials/introductory_tutorial.xml
+++ binaries/data/mods/public/maps/tutorials/introductory_tutorial.xml
@@ -40,7 +40,7 @@
{
"CircularMap": true,
"Description": "This is a basic tutorial to get you started playing 0 A.D.",
- "Keywords": ["demo"],
+ "Keywords": ["trigger"],
"LockTeams": false,
"Name": "Introductory Tutorial",
"PlayerData": [
Index: binaries/data/mods/public/simulation/components/GuiInterface.js
===================================================================
--- binaries/data/mods/public/simulation/components/GuiInterface.js
+++ binaries/data/mods/public/simulation/components/GuiInterface.js
@@ -209,6 +209,17 @@
};
};
+/**
+ *
+ */
+GuiInterface.prototype.GetCampaignGameEndData = function(player)
+{
+ let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+ if (Trigger.prototype.OnCampaignGameEnd)
+ return Trigger.prototype.OnCampaignGameEnd();
+ return {};
+};
+
GuiInterface.prototype.GetRenamedEntities = function(player)
{
if (this.miragedEntities[player])
@@ -1994,6 +2005,7 @@
"GetExtendedSimulationState": 1,
"GetInitAttributes": 1,
"GetReplayMetadata": 1,
+ "GetCampaignGameEndData": 1,
"GetRenamedEntities": 1,
"ClearRenamedEntities": 1,
"GetEntityState": 1,
Index: source/ps/GameSetup/GameSetup.cpp
===================================================================
--- source/ps/GameSetup/GameSetup.cpp
+++ source/ps/GameSetup/GameSetup.cpp
@@ -461,6 +461,7 @@
// We mount these dirs last as otherwise writing could result in files being placed in a mod's dir.
g_VFS->Mount(L"screenshots/", paths.UserData()/"screenshots"/"");
g_VFS->Mount(L"saves/", paths.UserData()/"saves"/"", VFS_MOUNT_WATCH);
+
// Mounting with highest priority, so that a mod supplied user.cfg is harmless
g_VFS->Mount(L"config/", readonlyConfig, 0, (size_t)-1);
if(readonlyConfig != paths.Config())
Index: source/ps/scripting/JSInterface_VFS.h
===================================================================
--- source/ps/scripting/JSInterface_VFS.h
+++ source/ps/scripting/JSInterface_VFS.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2018 Wildfire Games.
+/* Copyright (C) 2020 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@@ -47,6 +47,10 @@
// Save given JS Object to a JSON file
void WriteJSONFile(ScriptInterface::CmptPrivate* pCmptPrivate, const std::wstring& filePath, JS::HandleValue val1);
+ // Delete the given campaign save.
+ // This is limited to campaign save to avoid mods deleting the wrong file.
+ bool DeleteCampaignSave(ScriptInterface::CmptPrivate* pCmptPrivate, const CStrW& filePath);
+
// Tests whether the current script context is allowed to read from the given directory
bool PathRestrictionMet(ScriptInterface::CmptPrivate* pCmptPrivate, const std::vector& validPaths, const CStrW& filePath);
Index: source/ps/scripting/JSInterface_VFS.cpp
===================================================================
--- source/ps/scripting/JSInterface_VFS.cpp
+++ source/ps/scripting/JSInterface_VFS.cpp
@@ -209,6 +209,18 @@
g_VFS->CreateFile(path, buf.Data(), buf.Size());
}
+bool JSI_VFS::DeleteCampaignSave(ScriptInterface::CmptPrivate* UNUSED(pCmptPrivate), const CStrW& filePath)
+{
+ OsPath realPath;
+ if (filePath.Left(16) != L"saves/campaigns/" || filePath.Right(12) != L".0adcampaign")
+ return false;
+
+ return VfsFileExists(filePath) &&
+ g_VFS->GetRealPath(filePath, realPath) == INFO::OK &&
+ g_VFS->RemoveFile(filePath) == INFO::OK &&
+ wunlink(realPath) == 0;
+}
+
bool JSI_VFS::PathRestrictionMet(ScriptInterface::CmptPrivate* pCmptPrivate, const std::vector& validPaths, const CStrW& filePath)
{
for (const CStrW& validPath : validPaths)
@@ -259,6 +271,7 @@
scriptInterface.RegisterFunction("ReadFileLines");
scriptInterface.RegisterFunction("ReadJSONFile");
scriptInterface.RegisterFunction("WriteJSONFile");
+ scriptInterface.RegisterFunction("DeleteCampaignSave");
}
void JSI_VFS::RegisterScriptFunctions_Simulation(const ScriptInterface& scriptInterface)