ShowBattleAnim routine

TURBU

ShowBattleAnim routine

 

Displays a battle animation on-screen.

 

Syntax

 

procedure showBattleAnim(which: word; target: TRpgCharacter; wait, fullscreen: boolean);

 

Description

 

This routine plays a battle animation from the database.  The which parameter indicates the ID number of the animation to play, and target specifies the target of the animation.  If true is passed to wait, the script's execution will pause until the animation is finished, and if fullscreen is true, the animation will center itself at the center of the screen instead of on the target character, although a valid target parameter is still necessary for proper script execution.

If which is not a valid animation ID, target is not a valid character, or the graphics filename listed in the database for the animation does not refer to a valid image file, no animation will play.

This help file was created with the free trial version of HelpScribble.