Interrupt Method

Description

Interrupts the animation for the specified character.

Syntax

agent.Characters ("CharacterID").Interrupt Request

Remarks

You can use this to sync up animation between characters. For example, if another character is in a looping animation, this method will stop the loop and move to the next animation in the character's queue. You cannot interrupt a character animation that you are not using (that you have not loaded).

To specify the request parameter, you must create a variable and assign the animation request you want to interrupt:

    Dim GenieRequest as Object
    Dim RobbyRequest as Object
    Dim Genie as Object
    Dim Robby as Object

    Sub FormLoad()

        MyAgent1.Characters.Load "Genie", _ 
            "C:\Program Files\Microsoft Agent\Characters\Genie.acs"

        MyAgent1.Characters.Load "Robby", _
            "C:\Program Files\Microsoft Agent\Characters\Robby.acs"


        Set Genie = MyAgent1.Characters ("Genie")
        Set Robby = MyAgent1.Characters ("Robby")

        Genie.Show

        Genie.Speak "Just a moment"

        Set GenieRequest = Genie.Play ("Processing")

        Robby.Show
        Robby.Play "confused"
        Robby.Speak "Hey, Genie. What are you doing?"
        Robby.Interrupt GenieRequest

        Genie.Speak "I was just checking on something."

    End Sub

You cannot interrupt the animation of the same character you specify in this method because the server queues the Interrupt method in that character's animation queue. Therefore, you can only use Interrupt to halt the animation of another character you have loaded.

If you declare an object reference and set it to this method, it returns a Request object.

NoteInterrupt does not flush the character's queue; it halts the existing animation and moves on to the next animation in the character's queue. To halt and flush a character's queue, use the Stop method.