Usage
animate [tag=tag] [mask OR nomask] object-name animation-name imagecount framecount framedelay [framelist]
Note: [ ] denotes optional arguments.
Description
The animate command assigns a timed texture animation sequence to an object.
In order for the animate command to use a sequence of textures, they must all be part of the same numbered texture set with a shared base name. For example, a set named zin containing five textures would consist of the following textures:
Note that zin0 would not be considered a part of the set by the animate command. The first texture index is always 1 and a texture index never includes a leading "0" character.
- zin1
- zin2
- zin3
- zin4
- zin5
Note: By default, textures are treated as not masked. If you wish to use the animate command with masked textures you must explicitly specify the mask option or the textures will be applied as unmasked.
Separate help pages are available for information about the optional parameters:
The object-name argument specifies the name of the object to apply the animation to. This argument must be specified. If the animation is to be applied to this object, specify the keyword me as the object name. Object names are assigned via the name command.
The animation-name argument specifies the base name of the textures to be used in the animation.
The imagecount argument specifies the total number of unique textures in the animation. This always specifies the last index in a consecutive texture set with names formed by attaching the index number to the texture set name. The texture set should always start with texture number 1 of that set and end with a number equal to or greater than that which is specified by the imagecount argument. All textures in the specified set will be downloaded, from number 1 up to and including the number specified for this argument.
The framecount argument specifies the total number of steps in the animation sequence. Note this does not have to be the same as imagecount since a given image can be used more than once in an animation sequence or skipped entirely.
The framedelay argument specifies the time in milliseconds to delay after displaying a frame of the texture animation sequence, before moving on to the next frame. A framedelay of 0 means animate at the same rate as the browser's current frame rate. A framedelay of 1000 means animate at a rate of 1 second per frame.
The optional framelist argument allows you to specify the order of images to be displayed in the animation. This argument must be specified if imagecount and framecount are different. The default frame list is the numeric sequence consisting of 1 through imagecount.
For the application of a single texture onto an object rather than a sequence of textures, use the texture command.
Note that the animate and texture commands will not display textures predictably on objects which do not have UV texture values specified for the vertices of the object.
Examples
Note that in these examples, the animation will loop repeatedly. For information on making the animation not repeat, see the help pages for the astart and astop commands.
create animate mask me awd 8 8 1000
This action downloads the texture files awd1.jpg through awd8.jpg and the compressed .bmp mask files awd1m.zip through awd8m.zip which it applies to the object as masked textures in numerical order, with a 1-second delay between frames.
create animate me cabdoor 12 12 3000
This action downloads the texture files cabdoor1.jpg through cabdoor12.jpg and applies them to the object as unmasked textures in numerical order, with a 3-second delay between frames.
create animate mask me flo 9 9 750 9 8 7 6 5 4 3 2 1
This action downloads the texture files flo1.jpg through flo9.jpg and the compressed .bmp mask files flo1m.zip through flo9m.zip which it applies to the object as masked textures in reverse numerical order, with a 0.75-second delay between frames.
create animate me dresser 11 3 1500 7 10 5
This action downloads the texture files dresser1.jpg through dresser11.jpg and applies the textures dresser7, dresser10 and dresser5 to the object as unmasked textures in that order, with a 1.5-second delay between frames.
See the following help pages for additional information on the animate command: