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

BarrelAnimIsVoxel

From ModEnc
Jump to navigation Jump to search
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: BarrelAnimIsVoxel
File(s): rules(md).ini
Values: Boolean values: yes or no, true or false, 1 or 0
Applicable to: BuildingTypes


Specifies whether or not this building's barrel uses a voxel image.

Notes

Generally, this will ignore TurretAnimIsVoxel=yes and force TurretAnim to use Shape. In this case, VoxelBarrelFile= is used to specify a voxel barrel.

The exception is when TurretAnim specifies a name corresponding to a turret under the default naming convention for buildings, for example, [GTGCAN] sets TurretAnim=GTGCANTUR. In this case, this flag does not take effect, and VoxelBarrelFile, which relies on its effect, will not take effect either. The barrel is fixed to use the corresponding name under the default naming convention, i.e. GTGCANBARL.

Bugs/Side-Effects/Unexpected Limitations

Although BarrelAnimIsVoxel=yes already forces TurretAnim to be shaped, in vanilla it must be used together with TurretAnimIsVoxel=yes, which requires TurretAnim to use a voxel resource file. This creates an absurd situation: in the end, TurretAnim cannot use any kind of image resource file, and the game will only draw a Voxel barrel determined by VoxelBarrelFile.

  • Starting from Ares 2.0, this has been changed: the logic can now operate with TurretAnimIsVoxel=no, meaning it can normally use a Shape turret and a Voxel barrel.

This represents both an Example Animation Turret name and an example filenames for a Voxel turret, with the .vxl extension excluded.

Overview of Scenarios under Different Naming Rules

In rules(md).ini:

; Default naming convention
[example]                         ; BuildingType
TurretAnim=exampleTUR              ; Example filenames for Voxel turret, excluding the .vxl extension

; Manually invoke other objects
[example]                         ; BuildingType
TurretAnim=turret                  ; This name simultaneously represents an Animation Turret and a Voxel turret filename
VoxelBarrelFile=barrel             ; Example filename for Voxel barrel, excluding the .vxl extension
INI Image
TurretAnimIsVoxel BarrelAnimIsVoxel TURRET BARREL
no no Animation no
yes yes [1]
yes no Voxel File[2] yes
yes

Footnotes

  1. Starting from Ares 2.0
  2. For situations where the default naming convention is not used, the issue in #Bugs still exists, and in this case, the turret will have no image.

See Also