| Platform SDK: Agent |
| Part | Description |
|---|---|
| CharacterID | Returns the ID of the clicked character as a string. |
| Name | Returns a string value identifying the name (ID) of the command. |
| Cause | Returns a value that indicates what caused the Help mode to complete.
1 The user selected a command supplied by your application. 2 The user selected the Commands object of another client. 3 The user selected the Open Voice Commands command. 4 The user selected the Close Voice Commands command. 5 The user selected the Show CharacterName command. 6 The user selected the Hide CharacterName command. 7 The user selected (clicked) the character. |
Typically, Help mode completes when the user clicks or drags the character or selects a command from the character's pop-up menu. Clicking on another character or elsewhere on the screen does not cancel Help mode. The client that set Help mode for the character can cancel Help mode by setting HelpModeOn to False. (This does not trigger the HelpComplete event.)
When the user selects a command from the character's pop-up menu in Help mode, the server removes the menu, calls Help with the command's specified HelpContextID, and sends this event. The context-sensitive (also known as What's This?) Help window is displayed at the pointer location. If the user selects the command by voice input, the Help window is displayed over the character. If the character is off-screen, the window is displayed on-screen nearest to the character's current position.
If the server returns Name as an empty string (""), it indicates that the user selected a server-supplied command.
This event is sent only to the client application that places the character in Help mode.