Differential D2281 Diff 9752 binaries/data/mods/public/simulation/helpers/Attacking.js

Changeset View

Standalone View

binaries/data/mods/public/simulation/helpers/Attacking.js

/**		/**
* Provides attack and damage-related helpers under the Attacking umbrella (to avoid name ambiguity with the component).		* Provides attack and damage-related helpers under the Attacking umbrella (to avoid name ambiguity with the component).
*/		*/
function Attacking() {}		function Attacking() {}

/**		/**
* Builds a RelaxRNG schema of possible attack effects.		* Builds a RelaxRNG schema of possible attack effects.
		wraitiiUnsubmitted Done Inline Actions separated wraitii: separated
* Currently harcoded to "Damage", "Capture" and "StatusEffects".		* Currently harcoded to "Damage", "Capture" and "StatusEffects".
* Attacks may also have a "Bonuses" element.		* Attacks may also have a "Bonuses" element.
*		*
* @return {string} - RelaxNG schema string		* @return {string} - RelaxNG schema string
		StanUnsubmitted Done Inline Actions Missing '.' Still not sure whether it's @returns, or @return. Stan: Missing '.' Still not sure whether it's @returns, or @return.
*/		*/
Attacking.prototype.BuildAttackEffectsSchema = function()		Attacking.prototype.BuildAttackEffectsSchema = function()
{		{
return "" +		return "" +
"<oneOrMore>" +		"<oneOrMore>" +
"<choice>" +		"<choice>" +
"<element name='Damage'>" +		"<element name='Damage'>" +
"<oneOrMore>" +		"<oneOrMore>" +
"<element a:help='One or more elements describing damage types'>" +		"<element a:help='One or more elements describing damage types'>" +
"<anyName>" +		"<anyName>" +
// Armour requires Foundation to not be a damage type.		// Armour requires Foundation to not be a damage type.
"<except><name>Foundation</name></except>" +		"<except><name>Foundation</name></except>" +
"</anyName>" +		"</anyName>" +
"<ref name='nonNegativeDecimal' />" +		"<ref name='nonNegativeDecimal' />" +
"</element>" +		"</element>" +
"</oneOrMore>" +		"</oneOrMore>" +
"</element>" +		"</element>" +
"<element name='Capture' a:help='Capture points value'>" +		"<element name='Capture' a:help='Capture points value'>" +
"<ref name='nonNegativeDecimal'/>" +		"<ref name='nonNegativeDecimal'/>" +
"</element>" +		"</element>" +
"<element name='StatusEffects' a:help='Effects like poisoning or burning a unit.'>" +		"<element name='GiveStatus' a:help='Effects like poisoning or burning a unit.'>" +
"<oneOrMore>" +		"<oneOrMore>" +
"<element>" +		"<element>" +
"<anyName/>" +		"<anyName/>" +
"<interleave>" +		"<interleave>" +
		"<optional>" +
"<element name='Duration' a:help='The duration of the status while the effect occurs.'><ref name='nonNegativeDecimal'/></element>" +		"<element name='Duration' a:help='The duration of the status while the effect occurs.'><ref name='nonNegativeDecimal'/></element>" +
		"</optional>" +
		"<optional>" +
		FreagarachAuthorUnsubmitted Done Inline Actions Optional because we could have permanent status effects. Freagarach: Optional because we could have permanent status effects.
"<element name='Interval' a:help='Interval between the occurances of the effect.'><ref name='nonNegativeDecimal'/></element>" +		"<element name='Interval' a:help='Interval between the occurances of the effect.'><ref name='nonNegativeDecimal'/></element>" +
"<element name='Damage' a:help='Damage caused by the effect.'><ref name='nonNegativeDecimal'/></element>" +		"<element name='Damage' a:help='Damage caused by the effect.'><ref name='nonNegativeDecimal'/></element>" +
		"</optional>" +
		"<optional>" +
		"<element name='Modifiers' a:help='Modifiers caused by the status.'>" +
		"<oneOrMore>" +
		"<element>" +
		"<anyName/>" +
		"<interleave>" +
		"<element name='Path' a:help='Path to modify.'><text/></element>" +
		"<element name='Affects' a:help='An array of classes to affect.'>" +
		"<attribute name='datatype'>" +
		"<value>tokens</value>" +
		"</attribute>" +
		"<text/>" +
		"</element>" +
		"<element name='Operation' a:help='What operation to perform.'><text/></element>" +
		"<element name='Value' a:help='The value of the operation to perform.'><data type='decimal'/></element>" +
		"</interleave>" +
		"</element>" +
		"</oneOrMore>" +
		"</element>" +
		"</optional>" +
		FreagarachAuthorUnsubmitted Done Inline Actions Optional because we can have effects with only modifiers (which are applied once and removed after duration (or not)). But for `Damage` a lack of interval makes no sense. Freagarach: Optional because we can have effects with only modifiers (which are applied once and removed…
"</interleave>" +		"</interleave>" +
		FreagarachAuthorUnsubmitted Done Inline Actions This should be a one or more choice probably. Freagarach: This should be a one or more choice probably.
"</element>" +		"</element>" +
"</oneOrMore>" +		"</oneOrMore>" +
"</element>" +		"</element>" +
"</choice>" +		"</choice>" +
"</oneOrMore>" +		"</oneOrMore>" +
"<optional>" +		"<optional>" +
"<element name='Bonuses'>" +		"<element name='Bonuses'>" +
"<zeroOrMore>" +		"<zeroOrMore>" +
"<element>" +		"<element>" +
"<anyName/>" +		"<anyName/>" +
		FreagarachAuthorUnsubmitted Done Inline Actions This has to be fixed. If an entity has a direct effect (i.e. `Damage` or `Capture`) then, and only then, `Interval` makes sense. If no `Interval` is specified the direct effect is not applied. `DirectEffectsSchema` and `Interval` ought to be coupled for that reason. When only `Modifiers` is present, `Interval` is obselete since nothing happens at the `ExecuteEffect` then. Freagarach: This has to be fixed. If an entity has a direct effect (i.e. `Damage` or `Capture`) then, and…
		wraitiiUnsubmitted Done Inline Actions You can do that with <interleave> I think. Alternatively just wrap every other item in a function and have a choice of 'either you have Damage/Capture, then you need interval, or you don't'. wraitii: You can do that with <interleave> I think. Alternatively just wrap every other item in a…
		FreagarachAuthorUnsubmitted Done Inline Actions `interleave` does not give the desired result. I now lean strongly towards: "let the user find out". Freagarach: `interleave` does not give the desired result. I now lean strongly towards: "let the user find…
"<interleave>" +		"<interleave>" +
"<optional>" +		"<optional>" +
"<element name='Civ' a:help='If an entity has this civ then the bonus is applied'><text/></element>" +		"<element name='Civ' a:help='If an entity has this civ then the bonus is applied'><text/></element>" +
"</optional>" +		"</optional>" +
"<element name='Classes' a:help='If an entity has all these classes then the bonus is applied'><text/></element>" +		"<element name='Classes' a:help='If an entity has all these classes then the bonus is applied'><text/></element>" +
"<element name='Multiplier' a:help='The effect strength is multiplied by this'><ref name='nonNegativeDecimal'/></element>" +		"<element name='Multiplier' a:help='The effect strength is multiplied by this'><ref name='nonNegativeDecimal'/></element>" +
"</interleave>" +		"</interleave>" +
"</element>" +		"</element>" +
Show All 10 Lines	Attacking.prototype.GetAttackEffectsData = function(valueModifRoot, template, entity)
let ret = {};		let ret = {};

if (template.Damage)		if (template.Damage)
{		{
ret.Damage = {};		ret.Damage = {};
let applyMods = damageType =>		let applyMods = damageType =>
ApplyValueModificationsToEntity(valueModifRoot + "/Damage/" + damageType, +(template.Damage[damageType] \|\| 0), entity);		ApplyValueModificationsToEntity(valueModifRoot + "/Damage/" + damageType, +(template.Damage[damageType] \|\| 0), entity);
for (let damageType in template.Damage)		for (let damageType in template.Damage)
ret.Damage[damageType] = applyMods(damageType);		ret.Damage[damageType] = applyMods(damageType);
		wraitiiUnsubmitted Done Inline Actions This shouldn't go in Attacking.js but in a separate 'ModifierTemplate' helper or something, as other code could use it (see promotion diff) wraitii: This shouldn't go in Attacking.js but in a separate 'ModifierTemplate' helper or something, as…
}		}
if (template.Capture)		if (template.Capture)
ret.Capture = ApplyValueModificationsToEntity(valueModifRoot + "/Capture", +(template.Capture \|\| 0), entity);		ret.Capture = ApplyValueModificationsToEntity(valueModifRoot + "/Capture", +(template.Capture \|\| 0), entity);

if (template.StatusEffects)		if (template.GiveStatus)
ret.StatusEffects = template.StatusEffects;		ret.GiveStatus = template.GiveStatus;

if (template.Bonuses)		if (template.Bonuses)
ret.Bonuses = template.Bonuses;		ret.Bonuses = template.Bonuses;

return ret;		return ret;
};		};

Attacking.prototype.GetTotalAttackEffects = function(effectData, effectType, cmpResistance)		Attacking.prototype.GetTotalAttackEffects = function(effectData, effectType, cmpResistance)
▲ Show 20 Lines • Show All 150 Lines • ▼ Show 20 Lines	if (!cmpReceiver)
continue;		continue;

Object.assign(targetState, cmpReceiver[receiver.method](attackData[effectType], attacker, attackerOwner, bonusMultiplier));		Object.assign(targetState, cmpReceiver[receiver.method](attackData[effectType], attacker, attackerOwner, bonusMultiplier));
}		}

let cmpPromotion = Engine.QueryInterface(attacker, IID_Promotion);		let cmpPromotion = Engine.QueryInterface(attacker, IID_Promotion);
if (cmpPromotion && targetState.xp)		if (cmpPromotion && targetState.xp)
cmpPromotion.IncreaseXp(targetState.xp);		cmpPromotion.IncreaseXp(targetState.xp);

		SilierUnsubmitted Done Inline Actions INVALID_ENTITY Silier: INVALID_ENTITY
if (targetState.killed)		if (targetState.killed)
this.TargetKilled(attacker, target, attackerOwner);		this.TargetKilled(attacker, target, attackerOwner);
		wraitiiUnsubmitted Done Inline Actions This is unrelated, no? wraitii: This is unrelated, no?
		FreagarachAuthorUnsubmitted Done Inline Actions No indeed. Freagarach: No indeed.

Engine.PostMessage(target, MT_Attacked, {		Engine.PostMessage(target, MT_Attacked, {
"type": attackType,		"type": attackType,
"target": target,		"target": target,
"attacker": attacker,		"attacker": attacker,
"attackerOwner": attackerOwner,		"attackerOwner": attackerOwner,
"damage": -(targetState.HPchange \|\| 0),		"damage": -(targetState.HPchange \|\| 0),
"capture": targetState.captureChange \|\| 0,		"capture": targetState.captureChange \|\| 0,
"statusEffects": targetState.inflictedStatuses \|\| [],		"statusEffects": targetState.inflictedStatuses \|\| [],
});		});
};		};

/**		/**
* Gets entities near a give point for given players.		* Gets entities near a give point for given players.
		elexisUnsubmitted Done Inline Actions (It seems like indirection to test for a property of statuseffects (has interval or not) rather than test some isStatusEffect or type=Statuseffect, not sure what's happening with the code however, and also inserting that type information may be less performant and more memory consumptive) elexis: (It seems like indirection to test for a property of statuseffects (has interval or not) rather…
		FreagarachAuthorUnsubmitted Done Inline Actions Agreed, I was thinking about that. Indeed the only right way would be to insert a new property. Freagarach: Agreed, I was thinking about that. Indeed the only right way would be to insert a new property.
		FreagarachAuthorUnsubmitted Done Inline Actions I will add a new property for correctness. Freagarach: I will add a new property for correctness.
* @param {Vector2D} origin - The point to check around.		* @param {Vector2D} origin - The point to check around.
* @param {number} radius - The radius around the point to check.		* @param {number} radius - The radius around the point to check.
* @param {number[]} players - The players of which we need to check entities.		* @param {number[]} players - The players of which we need to check entities.
* @return {number[]} The id's of the entities in range of the given point.		* @return {number[]} The id's of the entities in range of the given point.
*/		*/
Attacking.prototype.EntitiesNearPoint = function(origin, radius, players)		Attacking.prototype.EntitiesNearPoint = function(origin, radius, players)
{		{
// If there is insufficient data return an empty array.		// If there is insufficient data return an empty array.
Show All 34 Lines