Differential D144 Diff 533 binaries/data/mods/public/simulation/components/StatisticsTracker.js

Changeset View

Standalone View

binaries/data/mods/public/simulation/components/StatisticsTracker.js

function StatisticsTracker() {}		function StatisticsTracker() {}

		const UPDATE_SEQUENCE_INTERVAL = 30000; // 30 seconds
		bbUnsubmitted Not Done Inline Actions use g_FooBarBaz I did prefer `// ms` instead of `// 30 seconds`, but no strong opinion bb: use g_FooBarBaz I did prefer `// ms` instead of `// 30 seconds`, but no strong opinion
		bbUnsubmitted Done Inline Actions use g_FooBar bb: use g_FooBar
		elexisUnsubmitted Not Done Inline Actions comment seems pointless elexis: comment seems pointless
		elexisUnsubmitted Done Inline Actions bump elexis: bump

StatisticsTracker.prototype.Schema =		StatisticsTracker.prototype.Schema =
"<a:component type='system'/><empty/>";		"<a:component type='system'/><empty/>";

StatisticsTracker.prototype.Init = function()		StatisticsTracker.prototype.Init = function()
{		{
this.unitsClasses = [		this.unitsClasses = [
"Infantry",		"Infantry",
"Worker",		"Worker",
▲ Show 20 Lines • Show All 126 Lines • ▼ Show 20 Lines	StatisticsTracker.prototype.Init = function()

this.tributesSent = 0;		this.tributesSent = 0;
this.tributesReceived = 0;		this.tributesReceived = 0;
this.tradeIncome = 0;		this.tradeIncome = 0;
this.treasuresCollected = 0;		this.treasuresCollected = 0;
this.lootCollected = 0;		this.lootCollected = 0;
this.peakPercentMapControlled = 0;		this.peakPercentMapControlled = 0;
this.teamPeakPercentMapControlled = 0;		this.teamPeakPercentMapControlled = 0;

		let cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
		if (!cmpTimer)
		return;
		this.updateTimer = cmpTimer.SetInterval(
		this.entity, IID_StatisticsTracker, "updateSequences", 0, UPDATE_SEQUENCE_INTERVAL);
};		};

/**		/**
* Returns a subset of statistics that will be added to the simulation state,		* Returns a subset of statistics that will be added to the simulation state,
* thus called each turn. Basic statistics should not contain data that would		* thus called each turn. Basic statistics should not contain data that would
* be expensive to compute.		* be expensive to compute.
*		*
* Note: as of now, nothing in the game needs that, but some AIs developed by		* Note: as of now, nothing in the game needs that, but some AIs developed by
Show All 37 Lines	return {
"teamPercentMapExplored": this.GetTeamPercentMapExplored(),		"teamPercentMapExplored": this.GetTeamPercentMapExplored(),
"percentMapControlled": this.GetPercentMapControlled(),		"percentMapControlled": this.GetPercentMapControlled(),
"teamPercentMapControlled": this.GetTeamPercentMapControlled(),		"teamPercentMapControlled": this.GetTeamPercentMapControlled(),
"peakPercentMapControlled": this.peakPercentMapControlled,		"peakPercentMapControlled": this.peakPercentMapControlled,
"teamPeakPercentMapControlled": this.teamPeakPercentMapControlled		"teamPeakPercentMapControlled": this.teamPeakPercentMapControlled
};		};
};		};

		StatisticsTracker.prototype.GetSequences = function()
		{
		let ret = clone(this.sequences);
		let cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
		if (!cmpTimer)
		bbUnsubmitted Done Inline Actions No need for checking system components afaik bb: No need for checking system components afaik
		return;

		ret.time.push(cmpTimer.GetTime() / 1000);
		this.PushValue(this.GetStatistics(), ret);
		return ret;
		}

/**		/**
* Increments counter associated with certain entity/counter and type of given entity.		* Increments counter associated with certain entity/counter and type of given entity.
* @param cmpIdentity The entity identity component		* @param cmpIdentity The entity identity component
* @param counter The name of the counter to increment (e.g. "unitsTrained")		* @param counter The name of the counter to increment (e.g. "unitsTrained")
* @param type The type of the counter (e.g. "workers")		* @param type The type of the counter (e.g. "workers")
*/		*/
		bbUnsubmitted Done Inline Actions IIRC we don't have caps after the hyphen, so remove them (some lines below too). If we do use caps there, add them in other comments bb: IIRC we don't have caps after the hyphen, so remove them (some lines below too). If we do use…
StatisticsTracker.prototype.CounterIncrement = function(cmpIdentity, counter, type)		StatisticsTracker.prototype.CounterIncrement = function(cmpIdentity, counter, type)
{		{
var classes = cmpIdentity.GetClassesList();		var classes = cmpIdentity.GetClassesList();
if (!classes)		if (!classes)
return;		return;

if (classes.indexOf(type) != -1)		if (classes.indexOf(type) != -1)
++this[counter][type];		++this[counter][type];
▲ Show 20 Lines • Show All 153 Lines • ▼ Show 20 Lines	StatisticsTracker.prototype.IncreaseResourceGatheredCounter = function(type, amount, specificType)

if (type == "food" && (specificType == "fruit" \|\| specificType == "grain"))		if (type == "food" && (specificType == "fruit" \|\| specificType == "grain"))
this.resourcesGathered.vegetarianFood += amount;		this.resourcesGathered.vegetarianFood += amount;
};		};

/**		/**
* @param type Generic type of resource (string)		* @param type Generic type of resource (string)
* @param amount Amount of resource, which should be added (integer)		* @param amount Amount of resource, which should be added (integer)
*/		*/
		elexisUnsubmitted Done Inline Actions integer does not exist in JS elexis: integer does not exist in JS
		ImarokAuthorUnsubmitted Not Done Inline Actions just used that, as we use it somewhere else in the code too Imarok: just used that, as we use it somewhere else in the code too
StatisticsTracker.prototype.IncreaseResourceUsedCounter = function(type, amount)		StatisticsTracker.prototype.IncreaseResourceUsedCounter = function(type, amount)
{		{
this.resourcesUsed[type] += amount;		this.resourcesUsed[type] += amount;
};		};

StatisticsTracker.prototype.IncreaseTreasuresCollectedCounter = function()		StatisticsTracker.prototype.IncreaseTreasuresCollectedCounter = function()
{		{
++this.treasuresCollected;		++this.treasuresCollected;
▲ Show 20 Lines • Show All 105 Lines • ▼ Show 20 Lines	StatisticsTracker.prototype.OnTerritoriesChanged = function(msg)
if (newPercent > this.peakPercentMapControlled)		if (newPercent > this.peakPercentMapControlled)
this.peakPercentMapControlled = newPercent;		this.peakPercentMapControlled = newPercent;

newPercent = this.GetTeamPercentMapControlled();		newPercent = this.GetTeamPercentMapControlled();
if (newPercent > this.teamPeakPercentMapControlled)		if (newPercent > this.teamPeakPercentMapControlled)
this.teamPeakPercentMapControlled = newPercent;		this.teamPeakPercentMapControlled = newPercent;
};		};

		StatisticsTracker.prototype.PushValue = function(fromData, toData)
		bbUnsubmitted Done Inline Actions Some JsDocs wouldn't hurt bb: Some JsDocs wouldn't hurt
		{
		if (typeof fromData == "object")
		for (let prop in fromData)
		{
		if (typeof toData[prop] != "object")
		bbUnsubmitted Done Inline Actions periods and hyphens bb: periods and hyphens
		ImarokAuthorUnsubmitted Not Done Inline Actions Where are periods and hyphens missing in your opinion? Imarok: Where are periods and hyphens missing in your opinion?
		{
		toData[prop] = [];
		toData[prop].push(fromData[prop]);
		bbUnsubmitted Done Inline Actions First create empty array then put elements in? merge lines bb: First create empty array then put elements in? merge lines
		}
		else
		this.PushValue(fromData[prop], toData[prop]);
		}
		else
		toData.push(fromData);
		};

		StatisticsTracker.prototype.updateSequences = function()
		{
		let cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
		if (!cmpTimer)
		bbUnsubmitted Done Inline Actions AFAIK, system components doesn't need to be checked for existance, happens a few times earlier too bb: AFAIK, system components doesn't need to be checked for existance, happens a few times earlier…
		return;

		// Don't do this on Init, because GetStatistics doesn't work in this state of the game
		if (!this.sequences)
		{
		elexisUnsubmitted Done Inline Actions When reading this comment , the question arises why GetState doesn't work in this state of the game. Should become more precise. elexis: When reading this comment , the question arises why GetState doesn't work in this state of the…
		this.sequences = clone(this.GetStatistics());
		this.sequences.time = [];
		}

		this.sequences.time.push(cmpTimer.GetTime() / 1000);
		this.PushValue(this.GetStatistics(), this.sequences);
		}

Engine.RegisterComponentType(IID_StatisticsTracker, "StatisticsTracker", StatisticsTracker);		Engine.RegisterComponentType(IID_StatisticsTracker, "StatisticsTracker", StatisticsTracker);