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