IsAnimated

Terrain object that plays through its artwork instead of holding a single frame.

Specification

Applies to

TerrainType

File

rules.ini

Section

[<ObjectType ID>]

Value

boolean

When omitted

no

The flag has two effects on terrain objects of the type:

• The object starts its animation by chance. On each game frame while the animation is stopped, it starts with the chance set by AnimationProbability. The animation runs from the first frame of the artwork at the pace set by AnimationRate.
• The object always shows its current animation frame. It no longer switches to its damaged frame when its strength drops below 2.

rules.ini

[MYTREE]              ; example blossom tree
IsAnimated=yes
AnimationRate=3
AnimationProbability=.02
SpawnsTiberium=yes

Only a Tiberium-spawning type stops its animation

An animated SpawnsTiberium=yes object stops when it reaches the middle frame of its shape file, where the shadow frames begin. It returns to its first frame, seeds Tiberium in a neighboring cell, and waits for AnimationProbability to start it again.

Any other animated type never stops once it has started. It runs on into the shadow frames and shows its shadow artwork as its body. Past the last frame in the file, it draws nothing.

See also — AnimationRate, AnimationProbability, SpawnsTiberium

Page feedback

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

Open issueSource revision 51b52aa38392