From WikiChip
Difference between revisions of "mirc/identifiers/$agent"
< mirc‎ | identifiers

(→‎Properties)
Line 1: Line 1:
−
{{mirc title|$agent Identifier}}'''$agent''' returns the filename of the Nth available agent installed on your system.
+
{{mirc title|$agent Identifier}}'''$agent''' returns the filename of the Nth available agent installed on your system, or informations about a loaded agent.
  
 
== Synopsis ==
 
== Synopsis ==
 
<pre>$agent(N).property</pre>
 
<pre>$agent(N).property</pre>
  
−
<pre>$agent(name).property</pre>
+
<pre>$agent(name,[N2]).property</pre>
  
 
== Paramters ==
 
== Paramters ==
  
−
None
+
<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 ==
 
== Properties ==
−
When N is passed as a parameter, the following property is available:
+
When '''N''' is passed as the first parameter, the following property is available:
 
{| class="wikitable" style="margin-left: 75px;"
 
{| class="wikitable" style="margin-left: 75px;"
 
|-
 
|-
Line 17: Line 21:
 
|-
 
|-
 
| '''char''' || Returns the character name of the Nth agent instead of the filename.
 
| '''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.
 
|}
 
|}
  

Revision as of 15:41, 17 December 2015

Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
v · d · e

$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

Paramters

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
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

//echo -a $agent(0)

Compatibility

Added: mIRC v6.32
Added on: 21 May 2008
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also

$agentname $agentopts $treebar

Retrieved from "https://en.wikichip.org/w/index.php?title=mirc/identifiers/$agent&oldid=13180"