$tip: Difference between revisions

From Scriptwiki
Jump to navigation Jump to search
Daveoh (talk | contribs)
No edit summary
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The $tip identifier has two functions, both listed here.
== Functions ==
=== Function 1 ===
The $tip() identifer allows you to create scripted tips that are independent of normal tip events.
The $tip() identifer allows you to create scripted tips that are independent of normal tip events.
  $tip(name,title,text,delay,iconfn,iconpos,alias,wid)
  $tip(name,title,text,[delay,iconfn,iconpos,alias,wid])
Returns Nth position of tip if it was successfully created, zero if not.
; Returns Nth position of tip if it was successfully created, zero if not.
 
'''Note:''' name, title, text are required.<br>
delay, iconfn, iconpos, alias, and wid can be $null.


=== Function 2 ===
Returns properties for the specified tip.
  $tip(name/N)
  $tip(name/N)
; Returns properties for the specified tip.


== Parameters and properties ==
== Parameters and properties ==
These are parameters for function 1 and properties for function 2.
* name - name of the tip
* name - name of the tip
* title - title
* title - title
Line 26: Line 17:


[[Category:Tips]]
[[Category:Tips]]
[[Category:Identifiers]]

Latest revision as of 08:42, 3 February 2011

The $tip() identifer allows you to create scripted tips that are independent of normal tip events.

$tip(name,title,text,[delay,iconfn,iconpos,alias,wid])
; Returns Nth position of tip if it was successfully created, zero if not.
$tip(name/N)
; Returns properties for the specified tip.

Parameters and properties

  • name - name of the tip
  • title - title
  • text - text
  • delay - from 3 to 60 seconds
  • iconfn - icon filename
  • iconpos - icon position in filename
  • alias - alias to perform when tip is double-clicked
  • wid - id of window to which tip belongs