The FlipBook entity is used to display a sequence of animated bitmaps. It can be placed in the level at the entity's location or used to replace a texture in the level.

Field Descriptions

The fields for the FlipBook entity are:

Field	Description
Alpha	Initial alpha of bitmaps
AlphaNameBase	Base name of alpha map sequence
AlphaRate	Amount to decrease alpha per second
AtLevelStart	Change texture only once at level start
BitmapCount	The total number of bitmaps in animation
BmpNameBase	Base name of bitmap sequence
BoneName	Name of actor bone to attach to
Color	Color of texture
EntityName	Name of the entity to attach this entity to
Model	Name of the world model to attach to
Rotation	Initial rotation, in degrees, of bitmaps
RotationRate	Amount to add to rotation per second
Scale	The initial amount to scale the bitmaps, where 1 equals 100%
ScaleRate	Amount to decrease the scale per second
Speed	The number of bitmaps per second that will be displayed
Style	The animation style, range 0 to 4
szEntityName	The name of this entity
TextureName	Name of texture to replace with animated bitmaps
TriggerName	Name of trigger entity

The BmpNameBase and AlphaNameBase entries are the base name of a sequence of bitmaps. The first bitmap in the sequence must be <name>0.bmp, the second <name>1.bmp and so on, where <name> is either BmpNameBase or AlphaNameBase.

If TextureName is not blank then the texture with that name (no .bmp extension is used) will be replaced throughout the level with the bitmap animation, and selecting Style 4 is the same as Style 1. The Style of the animation is as follows:

0 - no animation, display first bitmap only

1 - at end of animation repeat from start

2 - at end of animation reverse direction of animation

3 - chose random bitmap from list

4 - play through once then stop

For more information on attaching the FlipBook entity to another entity or model see Attaching Entities to an Actor, Player, or Model.