ItemLister class | lister.t[115], english.t[3106]

An Item Lister is a lister used for listing physical items. Notice that most of the specifics of the listers defined below are language-specific, and so are defined in the language-specific part of the library (e.g. in english.t).

Modified in english.t[3106]:
Modifications to the ItemLister (the base class for listers that list physical objects) for the English-language part of the library.

`class ItemLister : Lister`

Superclass Tree (in declaration order)

`ItemLister`
`Lister`
`object`

Subclass Tree

`ItemLister`
`CustomRoomLister`

Global Objects

`descContentsLister inventoryLister inventoryTallLister lookContentsLister lookInLister lookLister openingContentsLister remoteRoomContentsLister remoteSubContentsLister simpleAttachmentLister subLister wornLister`

Summary of Properties

`contentsListedProp groupTab listRecursively showAdditionalInfo showMovedToInfo showSubListing showWornInfo`

``

Summary of Methods

`findListGroups listName show showComplexList showList showSimpleList`

Inherited from `Lister` :
`buildList listed listOrder showListEmpty showListPrefix showListSuffix`

Properties

`contentsListedProp` | `lister.t[294]`

The property on a Thing-derived container to test whether its contents should be listed when listing with this lister

`groupTab` | `lister.t[161]`

Our LookUp table of any ListGroups we need to work with.

`listRecursively` | `lister.t[300]`

Flag, so we want to list contents of contents when using this lister; by default we do.

`showAdditionalInfo` | `english.t[3208]`

Flag: do we want to show additional information such as '(providing light)' after the names of items listed in inventory. By default we do.

`showMovedToInfo` | `english.t[3222]`

Flag: do we want to show {by the whatever) if after items that have notionally being moved to the vicinity of whatever.

`showSubListing` | `english.t[3229]`

Flag: do we want to show the contents of items listed in inventory (in parentheses after the name, e.g. a bag (in which is a blue ball)). By default we do if the actor is the player character.

`showWornInfo` | `english.t[3216]`

Flag: do we want to show (being worn) after items in an inventory list that the player character is wearing. By default we do if we're showing additional info.

Methods

`findListGroups (lst)` | `lister.t[163]`

no description available

`listName (o)` | `english.t[3135]`

The listName is the aName of o plus any status-specific information we might want to appear in the listing, such as '(providing light)'

`show (lst, parent, paraBrk, =, true)`OVERRIDDEN | `lister.t[122]`

Show a list of objects. 'lst' is the list of objects to show; 'parent' parameter is the object whose contents are being listed, 'paraBrk' defines whether or not we want a paragraph break after the list.

`showComplexList (lst, pl, parent)` | `lister.t[252]`

Show a list of items that may be a list of Things and ListGroups

`showList (lst, pl, parent)`OVERRIDDEN | `lister.t[138]`

Note that every item in our list has been mentioned and seen, provided it's listed.

`showSimpleList (lst)` | `lister.t[158], english.t[3125]`

Show a simple list of things. This must be defined in the language-specific part of the library.

Modified in english.t[3125]:
Show a simple list of things. For an item lister we use the listName method of the lister rather than the aName property of the object to provide a name for the object; this allows the lister to add status-specific information like '(providing light)' or '(being worn)' to the name as it appears in the list.

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