Page MenuHomeWildfire Games
Differential D3000 Diff 13426 binaries/data/mods/public/simulation/components/BuildRestrictions.js

Changeset View

Standalone View

View Options

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

function BuildRestrictions() {} function BuildRestrictions() {}
BuildRestrictions.prototype.Schema = BuildRestrictions.prototype.Schema =
"<a:help>Specifies building placement restrictions as they relate to terrain, territories, and distance.</a:help>" + "<a:help>Specifies building placement restrictions as they relate to terrain, territories, and distance.</a:help>" +
"<a:example>" + "<a:example>" +
"<BuildRestrictions>" + "<BuildRestrictions>" +
"<PlacementType>land</PlacementType>" + "<PlacementType>land</PlacementType>" +
"<Territory>own</Territory>" + "<Territory>own</Territory>" +
"<Category>Special</Category>" + "<Category>CivilCentre</Category>" +
"<Distance>" + "<Distance>" +
"<FromClass>CivilCentre</FromClass>" + "<FromClass>CivilCentre</FromClass>" +
"<MaxDistance>40</MaxDistance>" + "<MaxDistance>40</MaxDistance>" +
"</Distance>" + "</Distance>" +
"</BuildRestrictions>" + "</BuildRestrictions>" +
"</a:example>" + "</a:example>" +
"<element name='PlacementType' a:help='Specifies the terrain type restriction for this building.'>" + "<element name='PlacementType' a:help='Specifies the terrain type restriction for this building.'>" +
"<choice>" + "<choice>" +
▲ Show 20 Lines • Show All 118 Lines • ▼ Show 20 LinesBuildRestrictions.prototype.CheckPlacement = function()
if (this.template.Category == "Wall") if (this.template.Category == "Wall")
{ {
// for walls, only test the center point // for walls, only test the center point
var ret = cmpObstruction.CheckFoundation(passClassName, true); var ret = cmpObstruction.CheckFoundation(passClassName, true);
} }
else else
{ {
var ret = cmpObstruction.CheckFoundation(passClassName, false); var ret = cmpObstruction.CheckFoundation(passClassName, false);
Lint: JSHintBear
Inline Actions

'ret' is already defined.

Lint: JSHintBear: `'ret' is already defined.`
} }
if (ret != "success") if (ret != "success")
Lint: JSHintBear
Inline Actions

'ret' used out of scope.

Lint: JSHintBear: `'ret' used out of scope.`
{ {
switch (ret) switch (ret)
Lint: ESLintBear (default-case)
Inline Actions

Expected a default case.

Lint: ESLintBear (default-case): `Expected a default case.`
Lint: JSHintBear
Inline Actions

'ret' used out of scope.

Lint: JSHintBear: `'ret' used out of scope.`
{ {
case "fail_error": case "fail_error":
case "fail_no_obstruction": case "fail_no_obstruction":
error("CheckPlacement: Error returned from CheckFoundation"); error("CheckPlacement: Error returned from CheckFoundation");
break; break;
case "fail_obstructs_foundation": case "fail_obstructs_foundation":
result.message = markForTranslation("%(name)s cannot be built on another building or resource"); result.message = markForTranslation("%(name)s cannot be built on another building or resource");
break; break;
case "fail_terrain_class": case "fail_terrain_class":
// TODO: be more specific and/or list valid terrain? // TODO: be more specific and/or list valid terrain?
result.message = markForTranslation("%(name)s cannot be built on invalid terrain"); result.message = markForTranslation("%(name)s cannot be built on invalid terrain");
} }
return result; // Fail return result; // Fail
} }
// Check territory restrictions // Check territory restrictions
var cmpTerritoryManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TerritoryManager); var cmpTerritoryManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TerritoryManager);
var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player); var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
Lint: JSHintBear
Inline Actions

'cmpPlayer' is already defined.

Lint: JSHintBear: `'cmpPlayer' is already defined.`
var cmpPosition = Engine.QueryInterface(this.entity, IID_Position); var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
if (!(cmpTerritoryManager && cmpPlayer && cmpPosition && cmpPosition.IsInWorld())) if (!(cmpTerritoryManager && cmpPlayer && cmpPosition && cmpPosition.IsInWorld()))
return result; // Fail return result; // Fail
var pos = cmpPosition.GetPosition2D(); var pos = cmpPosition.GetPosition2D();
var tileOwner = cmpTerritoryManager.GetOwner(pos.x, pos.y); var tileOwner = cmpTerritoryManager.GetOwner(pos.x, pos.y);
var isConnected = !cmpTerritoryManager.IsTerritoryBlinking(pos.x, pos.y); var isConnected = !cmpTerritoryManager.IsTerritoryBlinking(pos.x, pos.y);
var isOwn = tileOwner == cmpPlayer.GetPlayerID(); var isOwn = tileOwner == cmpPlayer.GetPlayerID();
Show All 33 Lines if (!this.HasTerritory("enemy"))
invalidTerritory = markForTranslationWithContext("Territory type", "enemy"); invalidTerritory = markForTranslationWithContext("Territory type", "enemy");
} }
if (invalidTerritory) if (invalidTerritory)
{ {
result.message = markForTranslation("%(name)s cannot be built in %(territoryType)s territory. Valid territories: %(validTerritories)s"); result.message = markForTranslation("%(name)s cannot be built in %(territoryType)s territory. Valid territories: %(validTerritories)s");
result.translateParameters.push("territoryType"); result.translateParameters.push("territoryType");
result.translateParameters.push("validTerritories"); result.translateParameters.push("validTerritories");
result.parameters.territoryType = {"context": "Territory type", "message": invalidTerritory}; result.parameters.territoryType = {"context": "Territory type", "message": invalidTerritory};
Lint: ESLintBear (object-curly-spacing)
Inline Actions

A space is required after '{'.

Lint: ESLintBear (object-curly-spacing): `A space is required after '{'.`
Lint: ESLintBear (object-curly-spacing)
Inline Actions

A space is required before '}'.

Lint: ESLintBear (object-curly-spacing): `A space is required before '}'.`
// gui code will join this array to a string // gui code will join this array to a string
result.parameters.validTerritories = {"context": "Territory type list", "list": this.GetTerritories()}; result.parameters.validTerritories = {"context": "Territory type list", "list": this.GetTerritories()};
Lint: ESLintBear (object-curly-spacing)
Inline Actions

A space is required after '{'.

Lint: ESLintBear (object-curly-spacing): `A space is required after '{'.`
Lint: ESLintBear (object-curly-spacing)
Inline Actions

A space is required before '}'.

Lint: ESLintBear (object-curly-spacing): `A space is required before '}'.`
return result; // Fail return result; // Fail
} }
// Check special requirements // Check special requirements
if (this.template.PlacementType == "shore") if (this.template.PlacementType == "shore")
{ {
if (!cmpObstruction.CheckShorePlacement()) if (!cmpObstruction.CheckShorePlacement())
{ {
result.message = markForTranslation("%(name)s must be built on a valid shoreline"); result.message = markForTranslation("%(name)s must be built on a valid shoreline");
return result; // Fail return result; // Fail
} }
} }
let cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager); let cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
let templateName = cmpTemplateManager.GetCurrentTemplateName(this.entity); let templateName = cmpTemplateManager.GetCurrentTemplateName(this.entity);
let template = cmpTemplateManager.GetTemplate(removeFiltersFromTemplateName(templateName)); let template = cmpTemplateManager.GetTemplate(removeFiltersFromTemplateName(templateName));
// Check distance restriction // Check distance restriction
if (this.template.Distance) if (this.template.Distance)
{ {
var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager); var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
Lint: JSHintBear
Inline Actions

'cmpRangeManager' is already defined.

Lint: JSHintBear: `'cmpRangeManager' is already defined.`
var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player); var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
Lint: JSHintBear
Inline Actions

'cmpPlayer' is already defined.

Lint: JSHintBear: `'cmpPlayer' is already defined.`
var cat = this.template.Distance.FromClass; var cat = this.template.Distance.FromClass;
var filter = function(id) var filter = function(id)
{ {
var cmpIdentity = Engine.QueryInterface(id, IID_Identity); var cmpIdentity = Engine.QueryInterface(id, IID_Identity);
Lint: ESLintBear (no-shadow)
Inline Actions

'cmpIdentity' is already declared in the upper scope.

Lint: ESLintBear (no-shadow): `'cmpIdentity' is already declared in the upper scope.`
return cmpIdentity.GetClassesList().indexOf(cat) > -1; return cmpIdentity.GetClassesList().indexOf(cat) > -1;
}; };
if (this.template.Distance.MinDistance !== undefined) if (this.template.Distance.MinDistance !== undefined)
{ {
let minDistance = ApplyValueModificationsToTemplate("BuildRestrictions/Distance/MinDistance", +this.template.Distance.MinDistance, cmpPlayer.GetPlayerID(), template); let minDistance = ApplyValueModificationsToTemplate("BuildRestrictions/Distance/MinDistance", +this.template.Distance.MinDistance, cmpPlayer.GetPlayerID(), template);
if (cmpRangeManager.ExecuteQuery(this.entity, 0, minDistance, [cmpPlayer.GetPlayerID()], IID_BuildRestrictions).some(filter)) if (cmpRangeManager.ExecuteQuery(this.entity, 0, minDistance, [cmpPlayer.GetPlayerID()], IID_BuildRestrictions).some(filter))
{ {
let result = markForPluralTranslation( let result = markForPluralTranslation(
Lint: ESLintBear (no-shadow)
Inline Actions

'result' is already declared in the upper scope.

Lint: ESLintBear (no-shadow): `'result' is already declared in the upper scope.`
"%(name)s too close to a %(category)s, must be at least %(distance)s meter away", "%(name)s too close to a %(category)s, must be at least %(distance)s meter away",
"%(name)s too close to a %(category)s, must be at least %(distance)s meters away", "%(name)s too close to a %(category)s, must be at least %(distance)s meters away",
minDistance); minDistance);
result.success = false; result.success = false;
result.translateMessage = true; result.translateMessage = true;
result.parameters = { result.parameters = {
"name": name, "name": name,
"category": cat, "category": cat,
"distance": minDistance "distance": minDistance
}; };
result.translateParameters = ["name", "category"]; result.translateParameters = ["name", "category"];
return result; // Fail return result; // Fail
} }
} }
if (this.template.Distance.MaxDistance !== undefined) if (this.template.Distance.MaxDistance !== undefined)
{ {
let maxDistance = ApplyValueModificationsToTemplate("BuildRestrictions/Distance/MaxDistance", +this.template.Distance.MaxDistance, cmpPlayer.GetPlayerID(), template); let maxDistance = ApplyValueModificationsToTemplate("BuildRestrictions/Distance/MaxDistance", +this.template.Distance.MaxDistance, cmpPlayer.GetPlayerID(), template);
if (!cmpRangeManager.ExecuteQuery(this.entity, 0, maxDistance, [cmpPlayer.GetPlayerID()], IID_BuildRestrictions).some(filter)) if (!cmpRangeManager.ExecuteQuery(this.entity, 0, maxDistance, [cmpPlayer.GetPlayerID()], IID_BuildRestrictions).some(filter))
{ {
let result = markForPluralTranslation( let result = markForPluralTranslation(
Lint: ESLintBear (no-shadow)
Inline Actions

'result' is already declared in the upper scope.

Lint: ESLintBear (no-shadow): `'result' is already declared in the upper scope.`
"%(name)s too far from a %(category)s, must be within %(distance)s meter", "%(name)s too far from a %(category)s, must be within %(distance)s meter",
"%(name)s too far from a %(category)s, must be within %(distance)s meters", "%(name)s too far from a %(category)s, must be within %(distance)s meters",
maxDistance); maxDistance);
result.success = false; result.success = false;
result.translateMessage = true; result.translateMessage = true;
result.parameters = { result.parameters = {
"name": name, "name": name,
Show All 40 Lines
Wildfire Games · Phabricator