suggestedTopicLister object | actor.t[7125]

A special lister to display a topic inventory list from a list of topics provided in the lst parameter.

`suggestedTopicLister : object`

Superclass Tree (in declaration order)

`suggestedTopicLister`
`object`

Summary of Properties

`askForList askForPrefix askList askPrefix commandList enumerateSuggestions giveList givePrefix hyperlinkSuggestions noList optionsExplained orListSep queryList queryPrefix sayList sayPrefix showPrefix showToList talkList talkPrefix tellList tellPrefix tellToPrefix typeInfo yesList`

Summary of Methods

`explainOptions includes show showList showListEmpty showListPrefix showListSuffix showSection`

Properties

`askForList` | `actor.t[7451]`

no description available

`askForPrefix` | `actor.t[7474]`

no description available

`askList` | `actor.t[7444]`

no description available

`askPrefix` | `actor.t[7469]`

no description available

`commandList` | `actor.t[7452]`

no description available

`enumerateSuggestions` | `actor.t[7410]`

Do we want the topic suggestions to be numnered so that the player can just choose one by entering the approrpriae number. By default we don't but game code can override, or the player can use the ENUM SUGGS command to toggle this on and off.

`giveList` | `actor.t[7447]`

no description available

`givePrefix` | `actor.t[7472]`

no description available

`hyperlinkSuggestions` | `actor.t[7403]`

Do we want the topic suggestions to be hyperlinked so that the player can just click on them? By default we don't but game code can override , or the player can use the HYPER SUGGS command to toggle this on and off.

`noList` | `actor.t[7450]`

no description available

`optionsExplained` | `actor.t[7171]`

Have the enumeration and hyperlinking options been explained to the player?

`orListSep` | `actor.t[7478]`

The conjunction to use at the end of a list of alternatives

`queryList` | `actor.t[7443]`

no description available

`queryPrefix` | `actor.t[7468]`

no description available

`sayList` | `actor.t[7442]`

Sublists of each kind of suggestion which can be listed in turn

`sayPrefix` | `actor.t[7467]`

The prefix to use when suggesting a SayTopic, if it explicitly wants the suggestion to start with 'say'.

`showPrefix` | `actor.t[7473]`

no description available

`showToList` | `actor.t[7448]`

no description available

`talkList` | `actor.t[7446]`

no description available

`talkPrefix` | `actor.t[7471]`

no description available

`tellList` | `actor.t[7445]`

no description available

`tellPrefix` | `actor.t[7470]`

no description available

`tellToPrefix` | `actor.t[7475]`

no description available

`typeInfo` | `actor.t[7425]`

The typeInfo contains a list of lists that are used by the show method to build our various sublists. The first element of each list is a pointer to the list property to use on this lister object to hold the particular sublist. The second element of each list is a property pointer used to identify which sublist a TopicEntry belongs in, according to its own includeInList property. The third element is the type of topic entry a topic entry should be suggested as if it is explicitly requested in its suggestAs property. The fourth element is the text to use when introducing the corresponding section of the list (or nil if no introductory text is required).

`yesList` | `actor.t[7449]`

no description available

Methods

`explainOptions ( )` | `actor.t[7173]`

no description available

`includes (t, prop)` | `actor.t[7458]`

Test whether the topicEntry t includes prop in its includeInList.

`show (lst, explicit, =, true)` | `actor.t[7194]`

no description available

`showList (lst, sectionIntro)` | `actor.t[7335]`

Show one of our sublists of particular kinds of suggest topics

`showListEmpty (explicit)` | `actor.t[7185]`

The message to display if there are no topics to suggest.

`showListPrefix (lst, pl, explicit)` | `actor.t[7128]`

Introduce the topic inventory listing

`showListSuffix (lst, pl, explicit)` | `actor.t[7147]`

End the list with a closing parenthesis or full stop as appropriate

`showSection (prop, listStarted, sectionIntro)` | `actor.t[7307]`

Finish the list by appending its suffix

Adv3Lite Library Reference Manual
Generated on 03/07/2024 from adv3Lite version 2.1