From WikiChip
Difference between revisions of "mirc/identifiers/$tip"
< mirc‎ | identifiers

(Synopsis)
(Parameters)
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
== Synopsis ==
 
== Synopsis ==
<pre>$tip(<name>,<title>,<text>,delay,iconfn,iconpos,alias,wid) - create a tip, returns Nth position of tip if it was successfully created, 0 if not
+
<pre>$tip(<name>,<title>,<text>,delay,iconfn,iconpos,alias,wid)  
 +
create a tip, returns Nth position of tip if successfully created, 0 if not
  
 
$tip(N/name) - returns information about a tip
 
$tip(N/name) - returns information about a tip
 
</pre>
 
</pre>
  
== Paramters ==
+
== Parameters ==
  
 
* '''name''' - The name of your tip.
 
* '''name''' - The name of your tip.
Line 18: Line 19:
 
* '''alias''' - the alias that will be called when the tip is double clicked
 
* '''alias''' - the alias that will be called when the tip is double clicked
 
* '''wid''' - the id of the window to which the tip belongs
 
* '''wid''' - the id of the window to which the tip belongs
 +
* '''cid''' - the id of the connection to which the tip belongs
 
* '''N''' - reference the Nth tip.
 
* '''N''' - reference the Nth tip.
  
Line 41: Line 43:
 
{{mIRC|/tip}}
 
{{mIRC|/tip}}
 
{{mIRC|/tips}}
 
{{mIRC|/tips}}
{{mIRC|/$tips}}
+
{{mIRC|$tips}}
  
 
[[Category:mIRC identifiers]]
 
[[Category:mIRC identifiers]]

Latest revision as of 22:35, 16 August 2022

$tip Allows you to create scripted tips that are independent of normal tip events.


Synopsis[edit]

$tip(<name>,<title>,<text>,delay,iconfn,iconpos,alias,wid) 
create a tip, returns Nth position of tip if successfully created, 0 if not

$tip(N/name) - returns information about a tip

Parameters[edit]

  • name - The name of your tip.
  • title - The title of your tip.
  • text - The text appearing inside the tip, can contain colors
  • delay - The duration of the tip, betwee, 3 and 60
  • iconfn - the filename of the icon, if you want to use any
  • iconpos - the position of the icon for a file containing multiple icons
  • alias - the alias that will be called when the tip is double clicked
  • wid - the id of the window to which the tip belongs
  • cid - the id of the connection to which the tip belongs
  • N - reference the Nth tip.

Properties[edit]

When only one parameter is passed to $tip, you can use the following properties:

  • .name - returns the name of the tip (used with the N parameter typically)
  • .title - return the title of the tip
  • .text - return the text of the tip
  • .delay - return the delay of the tip
  • .iconfn - return the icon filename used if any
  • .iconpos - return the position of the icon for a file containing multiple icons
  • .alias - return the name of the alias called when double clicking the tip
  • .wid - return the id the window to which the tip belongs

Example[edit]

//echo -a $tip(test,test,test)

Compatibility[edit]

Added: mIRC v6.3
Added on: 16 Aug 2007
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also[edit]

/tip /tips $tips