StopAll Method

Description

Stops all animation requests or specified types of requests for the specified character.

Syntax

agent.Characters ("CharacterID").StopAll [Type]

Part Description
Type Optional. To use this parameter you can use any of the following values. You can also specify multiple types by separating them with commas.

"Get"            To stop all queued Get requests.

"NonQueuedGet"    To stop all non-queued Get requests (Get
            method with Queue parameter set to False).

"Move"        To stop all queued MoveTo requests.

"Play"            To stop all queued Play requests.

"Speak"        To stop all queued Speak requests.


Remarks

If you don't set the Type parameter, the server stops all animations for the character, including queued and non-queued Get requests, and clears its animation queue. It also stops playing a character's Hiding or Showing animation.

This method will not generate a Request object.

See Also

Stop method

--------------------------------------------------------