Differential D2337 Diff 10005 binaries/data/mods/public/globalscripts/DamageTypes.js

Changeset View

Standalone View

binaries/data/mods/public/globalscripts/DamageTypes.js

This file was added.

				/**
				* This class provides a cache for accessing damage types metadata stored in JSON files.
				* Note that damage types need not be defined in JSON files to be handled in-game.
				* This class must be initialised before using, as initialising it directly in globalscripts would
				* introduce disk I/O every time e.g. a GUI page is loaded.
				*/
				class DamageTypesMetadata
				{
				constructor()
				{
				this.damageTypeData = {};
				this.tooltipDamageTypes = [];

				for (let filename of Engine.ListDirectoryFiles("simulation/data/template_helpers/damage_types", "*.json", false))
				{
				let data = Engine.ReadJSONFile(filename);
				if (!data)
				continue;

				if (data.code in this.damageTypeData)
				{
				error("Encountered two damage types with the code " + data.name);
				continue;
				}

				this.damageTypeData[data.code] = data;

				if (data.showInTooltips)
				this.tooltipDamageTypes.push(data.code);
				}

				this._sort = (a, b) => this.damageTypeData[a].order - this.damageTypeData[b].order;
				wraitiiAuthorUnsubmitted Done Inline Actions I forgot here that I want damage types not in the data file to have lowest order, alphabetical. wraitii: I forgot here that I want damage types not in the data file to have lowest order, alphabetical.
				this.tooltipDamageTypes.sort(this._sort);
				}

				/**
				* @returns a copy in sorted order.
				*/
				sort(damageTypes)
				{
				let sorted = damageTypes.slice();
				sorted.sort(this._sort);
				return sorted;
				}

				/**
				* @returns the list of damage types to show in tooltips, ordered.
				*/
				getTooltipDamageTypes()
				{
				return this.tooltipDamageTypes;
				}

				/**
				* @returns the name of the @param code damage type, or @code if no metadata exists in JSON files.
				*/
				getName(code)
				{
				return this.damageTypeData[code] ? this.damageTypeData[code].name : code;
				}
				}