Page MenuHomeWildfire Games
Differential D154 Diff 1097 binaries/data/mods/public/globalscripts/Templates.js

Changeset View

Standalone View

View Options

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

Show First 20 Lines • Show All 65 Lines • ▼ Show 20 Lines
} }
/** /**
* Get information about a template with or without technology modifications. * Get information about a template with or without technology modifications.
* *
* NOTICE: The data returned here should have the same structure as * NOTICE: The data returned here should have the same structure as
* the object returned by GetEntityState and GetExtendedEntityState! * the object returned by GetEntityState and GetExtendedEntityState!
* *
* @param template A valid template as returned by the template loader. * @param {object} template - A valid template as returned by the template loader.
* @param player An optional player id to get the technology modifications * @param {number} player - An optional player id to get the technology modifications
* of properties. * of properties.
* @param auraTemplates An object in the form of {key: {auraName: "", auraDescription: ""}} * @param {object} auraTemplates - In the form of {key: {auraName: "", auraDescription: ""}}.
bbUnsubmitted
Done
Inline Actions

One could add spaces in the commented object for consistency, meh.
Committer can add them too

bb: One could add spaces in the commented object for consistency, meh. Committer can add them too
* @param resources An instance of the Resources prototype * @param {object} resources - An instance of the Resources prototype.
*/ */
function GetTemplateDataHelper(template, player, auraTemplates, resources) function GetTemplateDataHelper(template, player, auraTemplates, resources)
{ {
// Return data either from template (in tech tree) or sim state (ingame) // Return data either from template (in tech tree) or sim state (ingame).
let getEntityValue = function(tech_type) { // @param {string} value_path - Route to the value within the template.
// @param {string} mod_key - Modification key, if not the same as the value_path.
let getEntityValue = function(value_path, mod_key = null) {
wraitiiUnsubmitted
Not Done
Inline Actions

This function should be at the top scope instead. It will be useful for D302 and there's no reason not to put it there in general.

This function should not used g_CurrentModifiers but get a list of modifiers as a parameter, so that it becomes pure. See comments below about deriveAutoresearchedModifications.

Also, I'm not entirely sure why you add mod_key here, the description is unclear and it doesn't actually seem used?

wraitii: This function should be at the top scope instead. It will be useful for D302 and there's no…
s0600204AuthorUnsubmitted
Not Done
Inline Actions

Also, I'm not entirely sure why you add mod_key here, the description is unclear and it doesn't actually seem used?

See D92#5200.

Unless you meant why added in this commit. Hypothetically to reduce possibility of merge conflict with D92, which also changes code in this area, and looked to be closer to being committed at the time.

s0600204: > Also, I'm not entirely sure why you add mod_key here, the description is unclear and it…
bbUnsubmitted
Done
Inline Actions

periods

bb: periods
s0600204AuthorUnsubmitted
Not Done
Inline Actions

...are what lady-folk get roughly once a month. I'll add in some full-stops instead.

*ahem* ok, levity over. Back to work.

s0600204: ...are what lady-folk get roughly once a month. I'll add in some full-stops instead. *ahem* ok…
let current_value = template; let current_value = template;
for (let property of tech_type.split("/")) for (let property of value_path.split("/"))
current_value = current_value[property] || 0; current_value = current_value[property] || 0;
current_value = +current_value; current_value = +current_value;
bbUnsubmitted
Not Done
Inline Actions

This will crash when the template and tech paths does not correspond, but I guess thats ok.

bb: This will crash when the template and tech paths does not correspond, but I guess thats ok.
s0600204AuthorUnsubmitted
Not Done
Inline Actions

It should not crash. It may give the wrong value under certain specific circumstances, but it should not crash.

If you can prove evidence or a test case where it does crash, I'll look into it.

s0600204: It should not crash. It may give the wrong value under certain specific circumstances, but it…
if (!player) // Using .toFixed() to get around spidermonkey's treatment of numbers (3 * 1.1 = 3.3000000000000003 for instance).
return current_value; if (player)
bbUnsubmitted
Not Done
Inline Actions

Wondering what this call is (trying to) do...

bb: Wondering what this call is (trying to) do...
s0600204AuthorUnsubmitted
Not Done
Inline Actions

The same thing that the call does in the pre-revision state of the code.

If called from within a running game session, it returns the appropriately modified value by running it through the simulation state, which is more complete and includes player-specific modifications unlike the call below which only applies global or game-start modifications.

s0600204: The same thing that the call does in the pre-revision state of the code. If called from within…
bbUnsubmitted
Not Done
Inline Actions

Then I think it's broken, tested with the corral ups for cav speed...

probably out of scope of this diff

bb: Then I think it's broken, tested with the corral ups for cav speed... probably out of scope of…
return +ApplyValueModificationsToTemplate(mod_key || value_path, current_value, player, template).toFixed(8);
bbUnsubmitted
Not Done
Inline Actions

I don't suspect any stat needs to be displayed with more than 8 decimals, so seems fine

bb: I don't suspect any stat needs to be displayed with more than 8 decimals, so seems fine
if (typeof g_CurrentModifiers !== "undefined")
wraitiiUnsubmitted
Done
Inline Actions

I like adding "else" for incompatible ifs anyhow.

wraitii: I like adding "else" for incompatible ifs anyhow.
return +GetTechModifiedProperty(g_CurrentModifiers, GetIdentityClasses(template.Identity), mod_key || value_path, current_value).toFixed(8);
return ApplyValueModificationsToTemplate(tech_type, current_value, player, template); return current_value;
}; };
let ret = {}; let ret = {};
if (template.Armour) if (template.Armour)
ret.armour = { ret.armour = {
"hack": getEntityValue("Armour/Hack"), "hack": getEntityValue("Armour/Hack"),
"pierce": getEntityValue("Armour/Pierce"), "pierce": getEntityValue("Armour/Pierce"),
▲ Show 20 Lines • Show All 136 Lines • ▼ Show 20 Lines ret.heal = {
"hp": getEntityValue("Heal/HP"), "hp": getEntityValue("Heal/HP"),
"range": getEntityValue("Heal/Range"), "range": getEntityValue("Heal/Range"),
"rate": getEntityValue("Heal/Rate") "rate": getEntityValue("Heal/Rate")
}; };
if (template.ResourceGatherer) if (template.ResourceGatherer)
{ {
ret.resourceGatherRates = {}; ret.resourceGatherRates = {};
let baseSpeed = getEntityValue("ResourceGatherer/BaseSpeed");
for (let type in template.ResourceGatherer.Rates) for (let type in template.ResourceGatherer.Rates)
ret.resourceGatherRates[type] = getEntityValue("ResourceGatherer/Rates/"+ type); ret.resourceGatherRates[type] = getEntityValue("ResourceGatherer/Rates/"+ type) * baseSpeed;
} }
if (template.Loot) if (template.Loot)
{ {
ret.loot = {}; ret.loot = {};
for (let type in template.Loot) for (let type in template.Loot)
ret.loot[type] = getEntityValue("Loot/"+ type); ret.loot[type] = getEntityValue("Loot/"+ type);
} }
Show All 38 Linesfunction GetTemplateDataHelper(template, player, auraTemplates, resources)
if (template.Identity) if (template.Identity)
{ {
ret.selectionGroupName = template.Identity.SelectionGroupName; ret.selectionGroupName = template.Identity.SelectionGroupName;
ret.name = { ret.name = {
"specific": (template.Identity.SpecificName || template.Identity.GenericName), "specific": (template.Identity.SpecificName || template.Identity.GenericName),
"generic": template.Identity.GenericName "generic": template.Identity.GenericName
}; };
ret.icon = template.Identity.Icon; ret.icon = template.Identity.Icon;
ret.tooltip = template.Identity.Tooltip; ret.tooltip = template.Identity.Tooltip;
ret.requiredTechnology = template.Identity.RequiredTechnology; ret.requiredTechnology = template.Identity.RequiredTechnology;
ret.visibleIdentityClasses = GetVisibleIdentityClasses(template.Identity); ret.visibleIdentityClasses = GetVisibleIdentityClasses(template.Identity);
} }
if (template.UnitMotion) if (template.UnitMotion)
{ {
ret.speed = { ret.speed = {
"walk": getEntityValue("UnitMotion/WalkSpeed"), "walk": getEntityValue("UnitMotion/WalkSpeed"),
Show All 29 Linesfunction GetTemplateDataHelper(template, player, auraTemplates, resources)
if (template.WallPiece) if (template.WallPiece)
ret.wallPiece = { "length": +template.WallPiece.Length }; ret.wallPiece = { "length": +template.WallPiece.Length };
return ret; return ret;
} }
/** /**
* Get basic information about a technology template.
* @param {object} template - A valid template as obtained by loading the tech JSON file.
bbUnsubmitted
Not Done
Inline Actions

Never seen that hyphen in comments, nuke

bb: Never seen that hyphen in comments, nuke
s0600204AuthorUnsubmitted
Not Done
Inline Actions

Then with due respect, you're not looking very hard.

Hint: run ack --type=js "\* \@param \{" in binaries/data/mods/public and you'll find that more frequently than not, a hyphen is included.

s0600204: Then with due respect, you're not looking very hard. Hint: run `ack --type=js "\* \@param \{"`…
* @param {string} civ - Civilization for which the tech requirements should be calculated.
bbUnsubmitted
Done
Inline Actions

requirements seem to also be based on civ

bb: requirements seem to also be based on civ
*/
function GetTechnologyBasicDataHelper(template, civ)
{
return {
"name": {
"generic": template.genericName
},
"icon": template.icon ? "technologies/" + template.icon : undefined,
"description": template.description,
"reqs": DeriveTechnologyRequirements(template, civ)
};
}
/**
* Get information about a technology template. * Get information about a technology template.
* @param template A valid template as obtained by loading the tech JSON file. * @param {object} template - A valid template as obtained by loading the tech JSON file.
* @param civ Civilization for which the specific name should be returned. * @param {string} civ - Civilization for which the specific name and tech requirements should be returned.
bbUnsubmitted
Done
Inline Actions

See above

bb: See above
* @param resources An instance of the Resources prototype.
*/ */
function GetTechnologyDataHelper(template, civ, resources) function GetTechnologyDataHelper(template, civ, resources)
{ {
let ret = {}; let ret = GetTechnologyBasicDataHelper(template, civ);
// Get specific name for this civ or else the generic specific name
let specific;
if (template.specificName) if (template.specificName)
specific = template.specificName[civ] || template.specificName.generic; ret.name.specific = template.specificName[civ] || template.specificName.generic;
bbUnsubmitted
Done
Inline Actions

Trailling comma.

bb: Trailling comma.
bbUnsubmitted
Done
Inline Actions

Merge this with ret declaration above.

bb: Merge this with `ret` declaration above.
ret.name = {
"specific": specific,
"generic": template.genericName,
};
ret.icon = template.icon ? "technologies/" + template.icon : null;
ret.cost = { "time": template.researchTime ? +template.researchTime : 0 }; ret.cost = { "time": template.researchTime ? +template.researchTime : 0 };
for (let type of resources.GetCodes()) for (let type of resources.GetCodes())
bbUnsubmitted
Done
Inline Actions

Shouldn't that be undefined (instead on null)?
Imo ternary was better.

bb: Shouldn't that be `undefined` (instead on `null`)? Imo ternary was better.
ret.cost[type] = +(template.cost && template.cost[type] || 0); ret.cost[type] = +(template.cost && template.cost[type] || 0);
ret.tooltip = template.tooltip; ret.tooltip = template.tooltip;
ret.requirementsTooltip = template.requirementsTooltip || ""; ret.requirementsTooltip = template.requirementsTooltip || "";
ret.reqs = DeriveTechnologyRequirements(template, civ);
ret.description = template.description;
return ret; return ret;
} }
function calculateCarriedResources(carriedResources, tradingGoods) function calculateCarriedResources(carriedResources, tradingGoods)
{ {
var resources = {}; var resources = {};
bbUnsubmitted
Done
Inline Actions

Improper JsDocs (same as above).

bb: Improper JsDocs (same as above).
if (carriedResources) if (carriedResources)
for (let resource of carriedResources) for (let resource of carriedResources)
resources[resource.type] = (resources[resource.type] || 0) + resource.amount; resources[resource.type] = (resources[resource.type] || 0) + resource.amount;
if (tradingGoods && tradingGoods.amount) if (tradingGoods && tradingGoods.amount)
resources[tradingGoods.type] = resources[tradingGoods.type] =
(resources[tradingGoods.type] || 0) + (resources[tradingGoods.type] || 0) +
(tradingGoods.amount.traderGain || 0) + (tradingGoods.amount.traderGain || 0) +
(tradingGoods.amount.market1Gain || 0) + (tradingGoods.amount.market1Gain || 0) +
(tradingGoods.amount.market2Gain || 0); (tradingGoods.amount.market2Gain || 0);
return resources; return resources;
} }
Wildfire Games · Phabricator