Playctrl » History » Version 2
Per Amundsen, 02/03/2020 10:52 PM
1 | 1 | Per Amundsen | _Added in 3.8_ |
---|---|---|---|
2 | |||
3 | 2 | Per Amundsen | */playctrl [-aescpbnx q# m# f# rl# t#] [alias] [channel/nick/stop] <filename> [delay]* |
4 | 1 | Per Amundsen | |
5 | 2 | Per Amundsen | Allows "playing" a file to a channel or private window, line by line. |
6 | |||
7 | _Empty lines are treated as a delay._ |
||
8 | |||
9 | _See also [[$play]], [[$filename]], [[$pnick]], [[on PLAYEND]]._ |
||
10 | |||
11 | _Same as [[/play]]._ |
||
12 | |||
13 | *Switches* |
||
14 | |||
15 | -x - Treat the first line in the file as a regular text instead of line count if it is a number. |
||
16 | -a - Uses the [alias] parameter as the alias to be called instead of [[/msg]] or [[/notice]]. |
||
17 | -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). |
||
18 | -s - Can be used offline, will interpret lines as actual command instead of plaintext and execute them in the status window. |
||
19 | -c - Forces AdiIRC to interpret lines as actual command instead of plaintext and execute them in the specified window. |
||
20 | -n - Uses [[/notice]] instead of [[/msg]]. |
||
21 | -p - Indicates it is a priority request, the current play request is paused and will resume once this one is finished. |
||
22 | -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. |
||
23 | -r - Forces a single line to be chosen randomly and played. |
||
24 | -fN - Plays the whole file starting from the specified line. |
||
25 | -tTOPIC - Forces AdiIRC to look up the specified topic/section (INI structure) in the file and play all lines under that topic/section. |
||
26 | -lN - Forces the specified line number to be played. |
||
27 | -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. |
||
28 | -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. |
||
29 | |||
30 | _The last two switches only applies for a /playctrl request initiated via a remote definition, not by you._ |
||
31 | |||
32 | *Parameters* |
||
33 | |||
34 | [alias] - If you have specified -a, the alias that will be called instead of [[/msg]] or [[/notice]]. |
||
35 | [channel/nick/stop] - The window you want to play to, if required, or "stop" if you want to stop and clear the queue. |
||
36 | [filename] - The filename you want to play. |
||
37 | [delay] - You can specify a delay, in millisecond, between each line sent. |
||
38 | |||
39 | *Example* |
||
40 | |||
41 | <pre> |
||
42 | ; Play the file 'file,txt' to the channel '#chan'. |
||
43 | /playctrl #chan file.txt |
||
44 | |||
45 | ; Play a random line from the file 'file,txt' to the channel '#chan'. |
||
46 | /playctrl -r #chan file.txt |
||
47 | |||
48 | ; Stops and clears all files in the queue. |
||
49 | /playctrl stop |
||
50 | </pre> |