ItemListerclass
lister.t[115], english.t[2937]
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[2937]:
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 listRecursively showAdditionalInfo showSubListing showWornInfo
Summary of Methods
Inherited from Lister :
buildList listed listOrder showListEmpty showListPrefix showListSuffix
Properties
contentsListedProp
The property on a Thing-derived container to test whether its contents should be listed when listing with this lister
listRecursively
Flag, so we want to list contents of contents when using this lister; by default we do.
showAdditionalInfo
Flag: do we want to show additional information such as ‘(providing light)’ after the names of items listed in inventory. By default we do.
showSubListing
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.
showWornInfo
Flag: do we want to show (bveing worn) after items in an inventory list that the player character is wearing. By default we do if we’re showing additional info.
Methods
listName (o)
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
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.
showList (lst, pl, parent)OVERRIDDEN
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 15/03/2023 from adv3Lite version 1.6.1