Semiconductor & Computer Engineering
From WikiChip
$agent Identifier - mIRC
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
$agent returns the filename of the Nth available agent installed on your system, or informations about a loaded agent.
Synopsis
$agent(N).property
$agent(name,[N2]).property
Parameters
NThe Nth agent available on your system
nameThe name used in /gload to load the agent
N2The N2th queued line for a loaded agent.
Properties
When N is passed as the first parameter, the following property is available:
| Property | Description |
|---|---|
| char | Returns the character name of the Nth agent instead of the filename. |
When name is passed as the first parameter, the following properties are available:
| Property | Description |
|---|---|
| name | Returns the name you gave to this agent |
| fname | Returns the filename you gave to this agent, or the filename to the default agent |
| visible | Returns $true if the agent is visible, $false otherwise |
| x | Returns the x coordinate of the position of the agent (left) |
| y | Returns the y coordinate of the position of the agent (top) |
| w | Returns the current width of the agent |
| h | Returns the current height of the agent |
| ow | Returns the original width of the agent |
| oh | Returns the original height of the agent |
| speed | Returns the speaking speed of the agent |
| pitch | Returns the speaking pitch of the agent |
| idle | Returns $true if the idle behavior is on, $false otherwise |
| effects | Returns $true if the effects are on, $false otherwise |
| active | Returns $true if the agent is active, $false otherwise |
| langid | Returns the language ID of the system |
| balloon | Returns the balloons settings, can be on, off, size, pace, hide |
| hide | Returns the auto hide setting |
| anim | Returns the names of the animations available for this agent, you can use N2 to get the N2th animation. |
| line | Returns the list of lines currently queued for talking for this agent, you can use N2 to get the N2th line. |
Example
//echo -a $agent(0)
Compatibility
Added: mIRC v5.7
Added on: 02 Feb 2000
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.