Tip class | tips.t[96]

The Tip class. Each actual tip should be represented by an instance of this class. To show the tip, just call tipName.showTip(). If the tip has already been shown, or if the tips have been turned off completely, then nothing will be displayed.

`class Tip : object`

Superclass Tree (in declaration order)

`Tip`
`object`

Subclass Tree

(none)

Global Objects

`exitsTip footnotesTip fullScoreTip oopsTip scoreChangeTip undoTip`

Summary of Properties

`desc shown`

Summary of Methods

`makeShown shouldShowTip showTip showTipDesc`

Properties

`desc` | `tips.t[102]`

The actual text to display when this tip is shown. We'll wrap it in <.tip> tags automatically, and also add a paragraph break before it.

`shown` | `tips.t[163]`

flag: has this tip been shown before?

Methods

`makeShown ( )` | `tips.t[153]`

Mark this tip as shown. This method can be called by outside code before the tip has been triggered. If the tip informs the player of a certain command, for instance, then it would become redundant if the player has already used that command.

`shouldShowTip ( )` | `tips.t[135]`

should we show this tip when asked to?

`showTip ( )` | `tips.t[105]`

show this tip

`showTipDesc ( )` | `tips.t[122]`

display our tip description, I.E. the actual tip

TADS 3 Library Manual
Generated on 8/21/2012 from TADS version 3.1.2