AnimationRate

Game frames each frame of an animated terrain object's artwork is held for.

Specification

Applies to

TerrainType

File

rules.ini

Section

[<ObjectType ID>]

Value

integer

When omitted

0A pace of zero, which never advances the artwork.

The figure is only ever applied by IsAnimated=yes, and only at the moment a stopped animation is started again. It is a countdown in game frames: the artwork advances one frame each time that many pass, so 1 advances every frame — fifteen frames a second — and 15 advances once a second.

rules.ini

[MYTREE]                 ; example blossom tree
IsAnimated=yes
AnimationRate=3          ; one frame every three game frames, five a second
AnimationProbability=.02
SpawnsTiberium=yes

A pace of zero leaves the object stuck on its first frame

Zero is not a pace but a stopped animation, so starting the animation with it stops the animation again in the same step. The object is returned to its first frame, and because it counts as stopped it is eligible to be started again on the very next frame — which returns it to the first frame once more, for as long as the scenario runs.

See also — IsAnimated, AnimationProbability

Page feedback

Report an error or missing detail. The issue includes this page and revision.

Open issueSource revision 59fae722af8c