|
|
| Line 1: |
Line 1: |
| − | '''$agent''' can be used to return information about your currently installed Microsoft Agent.
| + | #REDIRECT [[mirc/identifiers/$agent]] |
| − | | |
| − | == Synopsis ==
| |
| − | <pre>$agent(<N|name>,[N])[.property]</pre>
| |
| − | | |
| − | == Parameters ==
| |
| − | <span style="display: inline-block; width: 60px;">'''N'''</span>This can be used to retrieve information about the Nth loaded Agent. If this paramter is 0, then mIRC will return the total number of installed agents.
| |
| − | | |
| − | <span style="display: inline-block; width: 60px;">'''name'''</span>When using an actual agent name, this parameter can retrieve information about that agent via the optional [.property] feature. If no properties are past, mIRC simply returns the agent name you originally specified.
| |
| − | | |
| − | <span style="display: inline-block; width: 60px;">'''[N]'''</span>The optional [N] parameter, when passed along with a valid agent name, will retrieve information regarding animation queues for that agent.
| |
| − | | |
| − | == Properties ==
| |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''active'''</span>Specifies if the agent is the active or topmost Agent window.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''anim'''</span>When coupled with an Agent ''name'', and the optional ''[N]'' parameter, this will give you information regarding the animations available to that Agent. If ''[N]'' is 1 or higher, this property will return the name of the Nth animation. If ''[N]'' is 0, this will return the total number of available animations for this Agent.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''balloon'''</span>Gets the current balloon properties for the Agent, which can be: ''on'', ''off'', ''size'', ''pace'', ''hide''.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''char'''</span>When coupled with an Nth passed parameter, rather than an Agent name, this property can return the file name for the Nth specified Agent. If N is 0, this property will return the total number of installed Agents.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''effects'''</span>Returns whether sound effects are on or off.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''fname'''</span>Returns the filename of the Agent, or default.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''hide'''</span>Returns the auto-hide setting.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''idle'''</span>Specifies whether idle behavior is on or off for the Agent.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''langid'''</span>Returns the language ID for the system.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''line'''</span>When coupled with an Agent ''name'', and the optional ''[N]'' parameter, this property will give you information regarding the queued lines waiting to be spoken by the Agent. If ''[N]'' is 1 or higher, this property will return the text in the Nth queued text line. If ''[N]'' is 0, this will return the total number of lines waiting to be spoken in the Agent queue.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''name'''</span>Returns the name you gave to the Agent requested.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''ow,oh'''</span>Returns the original width, or original height of the Agent.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''pitch'''</span>The current speaking pitch of the specified Agent.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''speed'''</span>The speed at which the Agent speaks.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''visible'''</span>Returns either ''$true'' or ''$false'' if the Agent is visible or not.
| |
| − | | |
| − | <span style="display: inline-block; line-height: 40px; width: 80px;">'''x,y,w,h'''</span>When any of these properties are specified, the identifier will retrieve the 'left', 'top', 'width', 'height' properties of the Agent, respectively.
| |
| − | | |
| − | == Example ==
| |
| − | '''Echo the total number of installed agents to the active window'''
| |
| − | <source lang="mIRC">//echo -a $agent(0)</source>
| |
| − | | |
| − | '''Echo the agent ''myAgent'' current ''x'' position to the active window'''
| |
| − | <source lang="mIRC">//echo -a $agent(myAgent).x</source>
| |
| − | | |
| − | '''Echo the total number of lines in the Agent speaking queue to the active window'''
| |
| − | <source lang="mIRC">//echo -a $agent(myAgent,0).line</source>
| |
| − | | |
| − | == Compatibility ==
| |
| − | Added: mIRC v5.7
| |
| − | | |
| − | Addon On: 02/02/2000
| |
| − | | |
| − | == See Also ==
| |
| − | * [[/gload command - mIRC|/gload]]
| |
| − | | |
| − | * [[/gunload command - mIRC|/gunload]]
| |
| − | | |
| − | * [[/gshow command - mIRC|/gshow]]
| |
| − | | |
| − | * [[/ghide command - mIRC|/ghide]]
| |
| − | | |
| − | * [[/gmove command - mIRC|/gmove]]
| |
| − | | |
| − | * [[/gsize command - mIRC|/gsize]]
| |
| − | | |
| − | * [[/gtalk command - mIRC|/gtalk]]
| |
| − | | |
| − | * [[/gplay command - mIRC|/gplay]]
| |
| − | | |
| − | * [[/gpoint command - mIRC|/gpoint]]
| |
| − | | |
| − | * [[/gstop command - mIRC|/gstop]]
| |
| − | | |
| − | * [[/gopts command - mIRC|/gopts]]
| |
| − | | |
| − | * [[/gqreq command - mIRC|/gqreq]]
| |
| − | | |
| − | * [[$agentname identifier - mIRC|$agentname]]
| |
| − | | |
| − | * [[$agentstat identifier - mIRC|$agentstat]]
| |
| − | | |
| − | * [[$agentver identifier - mIRC|$agentver]]
| |
| − | | |
| − | * [[On agent - mIRC|ON AGENT Event]]
| |
