Project

General

Profile

Play » History » Version 5

Per Amundsen, 07/09/2018 12:23 AM

1 1 Per Amundsen
_Added in 3.2_
2
3
*/play [-aescpbnx q# m# f# rl# t#] [alias] [channel/nick/stop] <filename> [delay]*
4
5
Allows "playing" a file to a channel or private window, line by line.
6
7
_Empty lines are treated as a delay._
8
9 2 Per Amundsen
_See also [[$play]], [[$pnick]]._
10
11 1 Per Amundsen
*Switches*
12
13
-x - Treat the first line in the file as a regular text instead of line count if it is a number.
14
-a - Uses the [alias] parameter as the alias to be called instead of [[/msg]] or [[/notice]].
15
-e - Echoes the line to channel/nick window as it would send them to the server (if the window does not exist, a line of the form [[/msg]] <window> <line> is displayed in the status window).
16
-s - Can be used offline, will interpret lines as actual command instead of plaintext and execute them in the status window.
17
-c - Forces AdiIRC to interpret lines as actual command instead of plaintext and execute them in the specified window.
18 4 Per Amundsen
-n - Uses [[/notice]] instead of [[/msg]].
19 1 Per Amundsen
-p - Indicates it is a priority request, the current play request is paused and will resume once this one is finished.
20
-b - Uses the clipboard instead of a file, the clipboard is temporarily saved to a file with a name of the form playqN.txt, which is deleted once playing is completed.
21
-r - Forces a single line to be chosen randomly and played.
22
-fN - Plays the whole file starting from the specified line.
23
-tTOPIC - Forces AdiIRC to look up the specified topic/section (INI structure) in the file and play all lines under that topic/section.
24
-lN - Forces the specified line number to be played.
25 5 Per Amundsen
26
This two switches only apply for a /play request initiated via a remote definition, not by you:
27
28
-mN - limits the number of requests that can be queued by a specific user/channel. If the user/channel already has or exceeds the specified number of requests queued then the play request is ignored.
29
-qN - Specifies the maximum number of requests that can be queued. If the queue length is already larger than or equal to the specified number then the play request is ignored.
30 1 Per Amundsen
31
*Parameters*
32
33
[alias] - If you have specified -a, the alias that will be called instead of [[/msg]] or [[/notice]].
34
[channel/nick/stop] - The window you want to play to, if required, or "stop" if you want to stop and clear the queue.
35
[filename] - The filename you want to play.
36
[delay] - You can specify a delay, in millisecond, between each line sent.
37
38
*Example*
39
40
<pre>
41 3 Per Amundsen
; Play the file 'file,txt' to the channel '#chan'.
42 1 Per Amundsen
/play #chan file.txt
43
44 3 Per Amundsen
; Play a random line from the file 'file,txt' to the channel '#chan'.
45 1 Per Amundsen
/play -r #chan file.txt
46
47
; Stops and clears all files in the queue.
48
/play stop
49
</pre>