Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/identifiers/$play"
(Created page with "{{mirc title|$play Identifier}}'''$play''' returns informations about queued /play request == Synopsis == <pre>$play(N) or $play(nick,N) </pre> == Paramters == * '''nick'''...") |
m (→Properties: Add paused response for .status) |
||
| Line 19: | Line 19: | ||
* '''.lines''' - returns the total number of lines in the file being played | * '''.lines''' - returns the total number of lines in the file being played | ||
* '''.delay''' - returns the delay used for the play request (default to 1000) | * '''.delay''' - returns the delay used for the play request (default to 1000) | ||
| − | * '''.status''' - returns the status of the play request, "playing" or "queued" | + | * '''.status''' - returns the status of the play request, "playing", "paused", or "queued" |
== Example == | == Example == | ||
Latest revision as of 21:23, 22 February 2024
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
$play returns informations about queued /play request
Synopsis[edit]
$play(N) or $play(nick,N)
Paramters[edit]
- nick - if you specify a nick, it returns how many play requests an user has in the queue.
- N - The Nth /play request queued
Properties[edit]
- .type - returns the type of the request, "topic" if you are using /play -t, "file" otherwise
- .fname - returns the complete filename used for the play request
- .topic - returns the name of the topic if you used /play -t
- .pos - returns the number of the line that play request is at, (the next line to be played)
- .lines - returns the total number of lines in the file being played
- .delay - returns the delay used for the play request (default to 1000)
- .status - returns the status of the play request, "playing", "paused", or "queued"
Example[edit]
//echo -a $play(0)
Compatibility[edit]
Added: mIRC v5.82
Added on: 14 Dec 2000
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.