$tip » History » Version 12
Per Amundsen, 02/23/2023 07:49 PM
1 | 1 | Per Amundsen | _Added in 1.9.3_ |
---|---|---|---|
2 | |||
3 | 2 | Per Amundsen | *$tip(name/N)* |
4 | 1 | Per Amundsen | |
5 | Returns properties for the specified tip. |
||
6 | |||
7 | 10 | Per Amundsen | _See also [[/tip]]._ |
8 | |||
9 | 1 | Per Amundsen | *Parameters* |
10 | |||
11 | 11 | Per Amundsen | table(ktable). |
12 | |*Parameter*|*Description*| |
||
13 | | name/N | Tip name or If N = 0 number of open tips, otherwise the Nth tip. | |
||
14 | 1 | Per Amundsen | |
15 | *Properties* |
||
16 | |||
17 | 11 | Per Amundsen | table(ktable). |
18 | |*Property*|*Description*| |
||
19 | | .name | Tip name. | |
||
20 | | .title | Tip title. | |
||
21 | | .text | Tip text. | |
||
22 | | .delay | Delay in milliseconds until tip closes. | |
||
23 | | .iconfn | Icon file name. | |
||
24 | | .iconpos | Icon position. | |
||
25 | | .alias | Alias to be executed on double click. | |
||
26 | | .wid | Window id associated with this tip. | |
||
27 | 1 | Per Amundsen | |
28 | 3 | Per Amundsen | -------------------------- |
29 | |||
30 | 1 | Per Amundsen | *$tip(name,title,text,delay,iconfn,iconpos,alias,wid)* |
31 | |||
32 | Allows you to create scripted tips that are independent of normal tip events. Returns Nth position of tip if it was successfully created, zero if not. |
||
33 | 3 | Per Amundsen | |
34 | _Title and text can have [[Formatting_text|Control Codes]]._ |
||
35 | 6 | Per Amundsen | |
36 | 9 | Per Amundsen | _Setting the delay to 0 makes the Tip "sticky" and have to be manually closed or the main window activated. *(AdiIRC only)*_ |
37 | 7 | Per Amundsen | |
38 | 12 | Per Amundsen | *Parameters* |
39 | |||
40 | table(ktable). |
||
41 | |*Parameter*|*Description*| |
||
42 | | name | Name of the tip. | |
||
43 | | title | The title of the tip. | |
||
44 | | text | The tip text. | |
||
45 | | delay | If 0 makes the tip "sticky", otherwise delay for N seconds before showing the tip. | |
||
46 | | iconfn | Icon/dll file to use for the tip. | |
||
47 | | iconpos | Icon position in the icon/dll file to use for the tip. | |
||
48 | | alias | Alias to execute when clicking the tip. | |
||
49 | | wid | [[$wid]] to associate the tip with. | |
||
50 | |||
51 | 6 | Per Amundsen | *Example* |
52 | |||
53 | <pre> |
||
54 | ; Create and show a Tip using the title 'title here' and the text 'text here'. |
||
55 | ; Prefix with /noop to ignore the result. |
||
56 | //noop $tip(name, title here, text here) |
||
57 | |||
58 | </pre> |