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

Difference between revisions of "TurretAnim"

From ModEnc
Jump to: navigation, search
 
m
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DeeZireInclusion}}<br />
+
{{Flag
Specifies the ART.INI reference (and thus the filename) of the turret to be used on this BuildingType. This is not required for VehicleTypes as their turret and barrel filenames are automatically derived from their standard voxel filenames by adding TUR for the turret filename and BARL for the barrel filename.
+
|name={{PAGENAME}}
 +
|files={{Categ|ini=rules}}
 +
|types={{Categ|BuildingTypes}}
 +
|values={{values|string|[[Animations]]}}
 +
|ts=yes
 +
|fs=yes
 +
|hp=yes
 +
|ra2=yes
 +
|yr=yes
 +
|ares=yes
 +
}}
 +
 
 +
This flag should be set to the [[animation]] to be rendered as a [[turret]] on this [[BuildingTypes|building type]]. The turret animation can be of three types:
 +
 
 +
== Voxel Turret == 
 +
 
 +
To render a [[voxel]] turret on a building, simply put the voxel's file name into the {{f|TurretAnim}} input and give the building the additional tag {{f|TurretAnimIsVoxel|true|link}}; the game will render the voxel directly onto the building without a need for a corresponding {{ini|art}} entry.
 +
 
 +
== SHP Turret ==
 +
 
 +
[[File:Turretrotation.png|thumb|frame|Turret shape orientation should start from the ▲ direction and rotate counter-clockwise, like in this example.]] To render a turret [[SHP|shape]] on a building, list the [[SHP|.shp]] animation entry in the {{f|TurretAnim}} input and see that {{f|TurretAnimIsVoxel|false|link}}; the game will expect that the turret animation has an {{ini|art}} entry. Turret shapes should have 32 frames and can have shadow frames, which unlike .shp-based vehicles turrets, do animate their shadows.
 +
 
 +
It will also need these:
 +
 
 +
{{f|LoopStart|0|link}}
 +
{{f|LoopEnd|32|link}}
 +
{{f|LoopCount|-1|link}}
 +
{{f|Rate|0|link}}
 +
 
 +
== Charge Animation ==
 +
 
 +
Here the turret logic has been "hijacked" for a special purpose. If the building has no turret ({{f|Turret|no|link}}) but has a valid {{f|TurretAnim}} entry and a [[primary]] weapon with {{f|Charges|yes|link}}, then this animation is used for the weapon charge-up animation. When the building acquires a target, this animation will play before the weapon can actually fire. An example of this is the Obelisk of Light in {{ts}}. Use {{f|TurretChargeAnimRate|link}} to specify the animation speed.
 +
 
 +
== See Also ==
 +
* [[TurretAnimIsVoxel]]
 +
* [[TurretAnimDamaged]]
 +
* [[TurretAnimX]]
 +
* [[TurretAnimY]]
 +
* [[TurretAnimZAdjust]]
 +
* [[TurretChargeAnimRate]]

Latest revision as of 17:45, 18 April 2022

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: TurretAnim
File(s): rules(md).ini
Values: Strings: Normal text. (Limited to: Animations)
Applicable to: BuildingTypes


This flag should be set to the animation to be rendered as a turret on this building type. The turret animation can be of three types:

Voxel Turret

To render a voxel turret on a building, simply put the voxel's file name into the TurretAnim input and give the building the additional tag TurretAnimIsVoxel=true; the game will render the voxel directly onto the building without a need for a corresponding art(md).ini entry.

SHP Turret

Turret shape orientation should start from the ▲ direction and rotate counter-clockwise, like in this example.
To render a turret shape on a building, list the .shp animation entry in the TurretAnim input and see that TurretAnimIsVoxel=false; the game will expect that the turret animation has an art(md).ini entry. Turret shapes should have 32 frames and can have shadow frames, which unlike .shp-based vehicles turrets, do animate their shadows.

It will also need these:

LoopStart=0
LoopEnd=32
LoopCount=-1
Rate=0

Charge Animation

Here the turret logic has been "hijacked" for a special purpose. If the building has no turret (Turret=no) but has a valid TurretAnim entry and a primary weapon with Charges=yes, then this animation is used for the weapon charge-up animation. When the building acquires a target, this animation will play before the weapon can actually fire. An example of this is the Obelisk of Light in Tiberian Sun. Use TurretChargeAnimRate to specify the animation speed.

See Also