Project

General

Profile

$play » History » Revision 2

Revision 1 (Per Amundsen, 07/08/2018 06:36 PM) → Revision 2/8 (Per Amundsen, 07/08/2018 06:36 PM)

_Added in 3.2_ 

 *$play([nick,]N)* 

 Returns information about the [[/play]] {{/play]] queue. 

 *Parameters* 

 nick - TODO 
 N - The Nth play file. 

 *Properties* 

  type - Returns the type of the request, "topic" if you are using /play -t, otherwise "file". 
 .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" or "queued". 

 *Example* 

 <pre> 
 ; Print the filename of the current playing file. 
 //echo -ag $play(1).fname 
 </pre>