Editing mirc/identifiers/$agent

{{mirc title|$agent Identifier}}'''$agent''' returns the filename of the Nth available agent installed on your system, or informations about a loaded agent.


== Synopsis ==
<pre>$agent(N).property</pre>

<pre>$agent(name,[N2]).property</pre>

== Parameters ==

<span style="display: inline-block; width: 50px;">'''N'''</span>The Nth agent available on your system

<span style="display: inline-block; width: 50px;">'''name'''</span>The name used in /gload to load the agent

<span style="display: inline-block; width: 50px;">'''N2'''</span>The N2th queued line for a loaded agent.

== Properties ==
When '''N''' is passed as the first parameter, the following property is available:
{| class="wikitable" style="margin-left: 75px;"
|-
! 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:

{| class="wikitable" style="margin-left: 75px;"
|-
! 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 {{mIRC|$true}} if the agent is visible, {{mIRC|$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 {{mIRC|$true}} if the idle behavior is on, {{mIRC|$false}} otherwise
|-
| '''effects''' || Returns {{mIRC|$true}} if the effects are on, {{mIRC|$false}} otherwise
|-
| '''active''' || Returns {{mIRC|$true}} if the agent is active, {{mIRC|$false}} otherwise
|-
| '''langid''' || Returns the language ID of the system
|-
| '''balloons''' || 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 ==
<source lang="mIRC">//echo -a $agent(0)</source>

== Compatibility ==
{{mIRC compatibility|5.7}}
== See Also ==
*{{mIRC|$agentname}}
*{{mIRC|$agentver}}
*{{mIRC|$agentstat}}
*{{mIRC|$notags}}
*{{mIRC|/gload}}
*{{mIRC|/gunload}}
*{{mIRC|/gtalk}}
*{{mIRC|/gshow}}
*{{mIRC|/ghide}}
*{{mIRC|/gmove}}
*{{mIRC|/gsize}}
*{{mIRC|/gplay}}
*{{mIRC|/gpoint}}
*{{mIRC|/gstop}}
*{{mIRC|/gopts}}
*{{mIRC|/gqreq}}
*{{mIRC|on events/on agent|on agent}}

[[Category:mIRC identifiers|agent]]