Stop Method

Description

Stops the animation for the specified character.

Syntax

agent.Characters ("CharacterID").Stop [Request]

Part Description
Request Optional. To use this parameter, set the Request object in your code.

Remarks

If you don't set the Request parameter, the server stops all animations for the character, including queued Get calls, and clears its animation queue unless the character is currently playing its Hiding or Showing animation. This method does not stop non-queued Get calls.

To stop a specific animation or Get call, declare an object variable and assign your animation request to that variable:

    Dim MyRequest
    Dim Genie

    Agent1.Characters.Load "Genie", _ 
        "http://agent.microsoft.com/characters/genie/genie.acf"

    Set Genie = Agent1.Characters ("Genie")

    Genie.Get "state", "Showing"
    Genie.Get "animation", "Greet, GreetReturn"

    Genie.Show
    
    'This animation will never play
    Set MyRequest = Genie.Play ("Greet")
    
    Genie.Stop MyRequest

This method will not generate a Request object.

See Also

StopAll method

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