Stop

Stop has two syntaxes.

To

Use

Deactivate a timing object

Syntax 1 For deactivating timing objects

Stop playing an animation

Syntax 2 For stopping an animation from playing


Syntax 1 For deactivating timing objects

Description

Deactivates a timing object.

Applies to

Timing objects

Syntax

timingobject.Stop ( )

Argument

Description

timingobject

The name of the timing object you want to deactivate

Returns

Integer. Returns 1 if it succeeds and -1 if the timer is not running or could not be stopped.

Usage

Use this function to deactivate a timing object. A stopped timer can be reactivated with the Start function.

Examples

Example 1

This statement stops the timing object instance MyTimer:

MyTimer.Stop()

See also


Syntax 2 For stopping an animation from playing

Description

Stops an animation (an AVI clip) from playing.

Applies to

Animation controls

Syntax

animationname.Stop ( )

Argument

Description

animationname

The name of the animation control displaying the AVI clip

Returns

Integer. Returns 1 if it succeeds and -1 if the animation is not running or could not be stopped.

Usage

Use this function to stop an animation that is playing. A stopped animation can be restarted with the Play function.

Examples

Example 2

This statement stops the AVI clip that is playing in the animation control MyAnimation:

MyAnimation.Stop()

See also