Hide Event

Platform SDK: Agent

Description

Occurs when a character is hidden.

Syntax

Sub agent_Hide (ByVal CharacterID, ByVal Cause)

Part	Description
CharacterID	Returns the ID of the hidden character as a string.
Cause	Returns a value that indicates what caused the character to hide. 1 User hid the character by selecting the command on the character's taskbar icon pop-up menu or using speech input. 3 Your client application hid the character. 5 Another client application hid the character. 7 User hid the character by selecting the command on the character's pop-up menu.

Part

Description

CharacterID

Returns the ID of the hidden character as a string.

Cause

Returns a value that indicates what caused the character to hide.

1 User hid the character by selecting the command on the character's taskbar icon pop-up menu or using speech input.

3 Your client application hid the character.

5 Another client application hid the character.

7 User hid the character by selecting the command on the character's pop-up menu.

The server sends this event to all clients of the character. To query the current state of the character, use the Visible property.