ListGroup class | lister.t[594], english.t[3233]

Abstract base class for all kinds of ListGroup. Game code will use one of more of its subclasses defined below.

Modified in english.t[3233]:
English-language modfications to the base ListGroup class.

`class ListGroup : object`

Superclass Tree (in declaration order)

`ListGroup`
`object`

Subclass Tree

`ListGroup`
`ListGroupCustom`
`ListGroupSorted`
`ListGroupParen`
`ListGroupSuffixPrefix`

Global Objects

(none)

Summary of Properties

`listOrder minGroupSize priority`

Summary of Methods

`showList showSimpleList`

Properties

`listOrder` | `lister.t[619]`

Our own list order, relative to the listOrder of other items in the list to be listed that do not belong to this ListGroup.

`minGroupSize` | `lister.t[600]`

The minimum number of objects in the list to be listed belonging to this ListGroup for this ListGroup to be used to list them. By default this is two.

`priority` | `lister.t[628]`

Normally if an item to be listed belongs to more than one ListGroup, we use the ListGroup that would contain the largest number of items. We can override this by assigning a higher priority to the ListGroup so that the highet priority ListGroup will be use. This should be a number that's large compared with the number of items in any one group so we use a default of 100. Game code may wish to assign priorities in steps of a hundred.

Methods

`showList (lister, lst)` | `lister.t[604]`

Show a list of items (lst) using lister.

`showSimpleList (lister, lst)` | `lister.t[613], english.t[3238]`

Show a simple list of items (lst) using lister. The method of doing so must be provided in the language-dependent part of the libary.

Modified in english.t[3238]:
Show a simple list of items lst using lister. Here we just create a simple and list: "a, b, c, ... and x"

Adv3Lite Library Reference Manual
Generated on 13/06/2025 from adv3Lite version 2.2.1