Plugin MsAgent

From VoxCommando
Jump to: navigation, search

Go to the main Plugins page.

Go to the complete Plugin List.


Plugin Description

Actions to create and control an MsAgent character

Actions for the MsAgent plugin

Show

MsAgent.Show
Creates and shows a new agent using the <Name> character. Hides any existing agent first.

Typical agent names that might be installed are merlin,robby etc.

  • Parameters: 1-2
  1. Name : The name of an installed agent character. [string]
  2. Voice : The name of the TTS voice to use [string]

Hide

MsAgent.Hide
Hides the current agent

Play

MsAgent.Play
Play an animation named <Name>

  • Parameters: 1
  1. Name : The name of the animation to play [string]

MoveTo

MsAgent.MoveTo
Moves the agent to the screen location <X>,<Y>
Uses the Agents move animation. See also MoveFast.

  • Parameters: 2
  1. X : pixel distance form left of screen [integer]
  2. Y : pixel distance form top of screen [integer]

MoveFast

MsAgent.MoveFast
Moves the agent to the screen location <X>,<Y>
Same as MoveTo but moves instantly without showing the move animation.

  • Parameters: 2
  1. X : pixel distance form left of screen [integer]
  2. Y : pixel distance form top of screen [integer]

GestureTo

MsAgent.GestureTo
Makes the agent gesture (point) towardso the screen location <X>,<Y>

  • Parameters: 2
  1. X : pixel distance form left of screen [integer]
  2. Y : pixel distance form top of screen [integer]

SoundEffectsOn

MsAgent.SoundEffectsOn
Turns animation sound effecs on.

SoundEffectsOff

MsAgent.SoundEffectsOff
Turns animation sound effecs off.

Speak

MsAgent.Speak
Makes the agent speak. Uses a word bubble and TTS.

  • Parameters: 1
  1. Text : The text the agent will speak [']