ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

AttachEffect

From ModEnc
Jump to navigation Jump to search

The AttachEffect system was designed as a spiritual successor to NPatch's Upgrade logic, but it was aimed to not be limited only to superweapons. AttachEffect tags can be applied to both the Big Four (all TechnoTypes) and Warheads, unless stated otherwise.

The state of AttachEffects on units does not update while in a transport, while under a temporal effect and so on. In this matter, they behave like IvanBombs.

To create a healing/repairing or residual damage effect, attach an animation with appropriate Warhead and Damage settings. This will affect the target unit for the entire duration of the AttachEffect, applying damage using the animation damage mechanism.

TechnoType & Warhead

Animation

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.Animation
File(s): rules(md).ini
Values: Strings: Normal text. (Limited to: Animation)
Default: none
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



The optional animation to play on the affected unit. The animation is attached to the unit and moves along with it.

The animation is removed when the unit is cloaked. The animation is recreated once the unit is uncloaked again. While cloaked, the AttachEffect is still applied, but the effects caused by the animation are not.

The animation always loops until the effect subsides. LoopCount is ignored.

Duration

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.Duration
File(s): rules(md).ini
Values: Signed integers: All whole numbers from -2147483648 to 2147483647; in rare cases, only from -32768 to 32767.
Special Values:  -1, infinite duration.
Default: 0
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



The duration of the effect in frames.


TemporalHidesAnim

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.TemporalHidesAnim
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Whether a TechnoType with this type of AttachEffect applied on it should remove the animation while being warped out by a Temporal=yes weapon. Otherwise the animation stays active and unaffected by the temporal weapon.

SpeedMultiplier

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.SpeedMultiplier
File(s): rules(md).ini
Values: Floating point values: Any decimal number (clearer range should be added in Template:Values).
Default: 1.0
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Speed bonus while the AttachEffect lasts.

ArmorMultiplier

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.ArmorMultiplier
File(s): rules(md).ini
Values: Floating point values: Any decimal number (clearer range should be added in Template:Values).
Default: 1.0
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Armor bonus while the AttachEffect lasts.

FirepowerMultiplier

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.FirepowerMultiplier
File(s): rules(md).ini
Values: Floating point values: Any decimal number (clearer range should be added in Template:Values).
Default: 1.0
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Firepower bonus while the AttachEffect lasts.

ROFMultiplier

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.ROFMultiplier
File(s): rules(md).ini
Values: Floating point values: Any decimal number (clearer range should be added in Template:Values).
Default: 1.0
Extension Version: 2.0+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Rate of fire bonus while the AttachEffect lasts.

Mind that this works fundamentally differently from the other effects, which are applied the instant they are needed (like a firepower for a bullet impacting) as long as the effect is active: the reload time is computed once when the reloading starts, but the modified reloading time may take longer than the attached effect lasts. For instance, a unit that was struck with an effect slowing down the ROF extremely might thus render the unit unable to fire way longer than the AttachEffect is active, because the reload timer will not speed up again when the effect expires.

Cloakable

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.Cloakable
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.4+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Whether the unit gains cloaking ability while the AttachEffect lasts.

ForceDecloak

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.ForceDecloak
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.5+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Whether affected units will be forced to decloak when the AttachEffect gets applied (useful for non-damaging anim-based AttachEffects).

Due to the above design purpose, this will only take effect once when applied to the target, and ignores the duration set by AttachEffect.Duration.

DiscardOnEntry

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.DiscardOnEntry
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.5+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Whether affected units will be forced to decloak when the AttachEffect gets applied (useful for non-damaging anim-based AttachEffects).

PenetratesIronCurtain

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.PenetratesIronCurtain
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.D+.
Applicable to: Warhead, TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Whether the AttachEffect can attach to a unit or structure under the influence of an Iron Curtain or Force Shield.

TechnoType Only

Delay

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.Delay
File(s): rules(md).ini
Values: Signed integers: All whole numbers from -2147483648 to 2147483647; in rare cases, only from -32768 to 32767.
Default: 0
Extension Version: 0.4+.
Applicable to: TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Defines how many frames after the previous effect subsides the AttachEffect is recreated on the unit itself. Negative values do not renew the effect.

InitialDelay

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.InitialDelay
File(s): rules(md).ini
Values: Signed integers: All whole numbers from -2147483648 to 2147483647; in rare cases, only from -32768 to 32767.
Special Values: 0, create effect immediately.
Default: 0
Extension Version: 0.C+.
Applicable to: TechnoTypes:

AircraftTypes, BuildingTypes, InfantryTypes and VehicleTypes

This flag is part of Ares. Do not use it without Ares installed.



Defines the delay before creating the AttachEffect for the very first time. Subsequent delays are defined by AttachEffect.Delay.

Warheads Only

Cumulative

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.Cumulative
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.4+.
Applicable to: Warhead

This flag is part of Ares. Do not use it without Ares installed.



  • If set to yes, an unlimited amount of this type of AttachEffect from this warhead can be applied to the target (it is stackable).
  • If no, only one instance of this type of the AttachEffect can be on a single unit and that one instance gets updated if it is to be applied again.

AnimResetOnReapply

Tiberian Dawn The Covert Operations Red Alert Counterstrike Aftermath Tiberian Sun Firestorm HyperPatch Red Alert 2 Yuri's Revenge Ares Generals Zero Hour Tiberium Wars Kane's Wrath
Flag: AttachEffect.AnimResetOnReapply
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Default: no
Extension Version: 0.4+.
Applicable to: Warhead

This flag is part of Ares. Do not use it without Ares installed.



If this type of AttachEffect is not stackable, enabling this flag resets the animation on every time of reapplying.

References

Starting from Phobos Build#41, a new AttachEffect ingame entities is available to allow setting various effects for each type of technos, warheads, and weapons, and to expand more features. Refer to Phobos documentation.

See Also

Type#For_SuperWeaponTypes