MessageHelper class | en_us.t[3153]

Some helper routines for the library messages.

`class MessageHelper : object`

Superclass Tree (in declaration order)

`MessageHelper`
`object`

Subclass Tree

(none)

Global Objects

`libMessages playerActionMessages`

Summary of Properties

``

(none)

Summary of Methods

`askDisambigList shortTIMsg shortTMsg`

Properties

(none)

Methods

`askDisambigList (matchList, fullMatchList, showIndefCounts, dist)` | `en_us.t[3160]`

Show a list of objects for a disambiguation query. If 'showIndefCounts' is true, we'll show the number of equivalent items for each equivalent item; otherwise, we'll just show an indefinite noun phrase for each equivalent item.

`shortTIMsg (short, long)` | `en_us.t[3270]`

For a TIAction result, select the short-form or long-form message. This works just like shortTIMsg(), but takes into account both the direct and indirect objects.

`shortTMsg (short, long)` | `en_us.t[3247]`

For a TAction result, select the short-form or long-form message, according to the disambiguation status of the action. This is for the ultra-terse default messages, such as "Taken" or "Dropped", that sometimes need more descriptive variations.

If there was no disambiguation involved, we'll use the short version of the message.

If there was unclear disambiguation involved (meaning that there was more than one logical object matching a noun phrase, but the parser was able to decide based on likelihood rankings), we'll still use the short version, because we assume that the parser will have generated a parenthetical announcement to point out its choice.

If there was clear disambiguation involved (meaning that more than one in-scope object matched a noun phrase, but there was only one choice that passed the logicalness tests), AND the announcement mode (in gameMain.ambigAnnounceMode) is DescribeClear, we'll choose the long-form message.

TADS 3 Library Manual
Generated on 5/16/2013 from TADS version 3.1.3