Differential D11 Diff 14538 binaries/data/mods/public/gui/common/campaigns/CampaignRun.js

Changeset View

Standalone View

binaries/data/mods/public/gui/common/campaigns/CampaignRun.js

This file was added.

				// 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 => {
				Lint: ESLintBear (consistent-return) Inline Actions `Expected to return a value at the end of arrow function.` Lint: ESLintBear (consistent-return): `Expected to return a value at the end of arrow function.`
				let filename = path.replace("saves/campaigns/", "").replace(".0adcampaign", "");
				try
				{
				return new CampaignRun(filename).load();
				}
				catch(err) {}
				Lint: ESLintBear (no-empty) Inline Actions `Empty block statement.` Lint: ESLintBear (no-empty): `Empty block statement.`
				}).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");
				}
				}
				StanUnsubmitted Done Inline Actions How does this work for normal savegames? Stan: How does this work for normal savegames?
				wraitiiAuthorUnsubmitted Done Inline Actions ? wraitii: ?