Editing MG/Attack-boost

Attack boosts are a [[MegaGlest]] only extender which allows boosts to be applied to units when attacking, such as increasing the attacker and units near the attack's stats. These appear inside the attack skill.

{{TOC limit|2}}

==XML==
<syntaxhighlight lang="xml">
<attack-boost>
	<allow-multiple-boosts value="false" />
	<radius value="5" />
	<target value="all|ally|foe|faction">
		<unit-type name="name" />
	</target>
	<max-hp value="0" value-percent-multipler="false" />
	<max-ep value="0" value-percent-multipler="false" />
	<sight value="0" value-percent-multipler="false" />
	<attack-strenght value="0" value-percent-multipler="false" />
	<attack-range value="0" value-percent-multipler="false" />
	<armor value="0" value-percent-multipler="false" />
	<move-speed value="0" value-percent-multipler="false" />
	<production-speed value="0" value-percent-multipler="false" />
	<particles value="true">
		<originator-particle-file path="glow_particles.xml" />
		<affected-particle-file path="glow_particles.xml" />
	</particles>
</attack-boost>
</syntaxhighlight>

==Documentation==
===allow-multiple-boosts===
If true, there can be multiple boosts, which will stack. If false, boosts cannot stack, but will simply overwrite.

===radius===
The maximum distance from the attacking unit from which the attack-boost will take effect.

===target===
This tag defines who gets effected by the attack boosts. The value defines the broad characteristic, either <tt>all</tt> (any unit, regardless of alliances), <tt>ally</tt> (only allied units), <tt>foe</tt> (only opposing units), or <tt>faction</tt> (only units in the same faction).<!-- Why is "unit-types" not listed here? Because you can now have unit-type children in any of these types, it does the same thing as the "all" type, making it useless -->

This tag can have <tt>unit-type</tt> children which can limit them down to only the listed units that fit the broader characteristic previously listed. However, it's also possible to use just these broader characteristics. For example, having just <tt>&lt;target value="ally" /&gt;</tt> allows it to effect all unit types of all allies. However, you can give it <tt>unit-type</tt> children tags to allow it to effect those types of units only if they are allies. For example, you might want it to only boost allied melee units, where you'd set the target value to ally and give a child <tt>unit-type</tt> tag to each melee unit.

===max-hp===
How much to effect the max HP by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===max-ep===
How much to effect the max EP by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===sight===
How much to effect the sight by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===attack-strenght===
How much to effect the attack strength by (note the necessary misspelling of the tag). Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===attack-range===
How much to effect the attack range by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===armor===
How much to effect the armor by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===move-speed===
How much to effect the move speed by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===production-speed===
How much to effect the production speed by. Negative numbers can decrease the skill. If the <tt>value-percent-multipler</tt> is true, the number is a percentage (where 100 is the same as no multiplier, 200 is the same as a doubling the stat, and 50 is the same as halving the stat). If <tt>value-percent-multipler</tt> is false, then the number is static, meaning it increases or decreases by the amount specified.

===Particles===
It's also possible to apply particle systems to the attacker and/or the affected units. These tags are optional. The attack can be given a particle system with the <tt>originator-particle-file</tt> tag, while the affected units can be given one with the <tt>affected-particle-file</tt> tag.

==Example==
In this example, all swordmen in the same faction within a five cell radius of the attacking unit will gain 10% more HP and +20 attack. The affected units will all have the particle system defined in the <tt>glow_particles.xml</tt> file applied to them.

<syntaxhighlight lang="xml">
<attack-boost>
	<allow-multiple-boosts value="false" />
	<radius value="5"/>
	<target value="faction">
		<unit-type name="swordman" />
	</target>
	<max-hp value="110" value-percent-multipler="true" />
	<max-ep value="0"/>
	<sight value="0"/>
	<attack-strenght value="20"/>
	<attack-range value="0"/>
	<armor value="0"/>
	<move-speed value="0" />
	<production-speed value="0"/>
	<particles value="true">
		<affected-particle-file path="glow_particles.xml"/>
	</particles>
</attack-boost>
</syntaxhighlight>

==See also==
*[[MegaGlest]]
*[[MG/Features|List of MegaGlest features]]
[[Category:MG]]
[[Category:Detailed feature pages]]