HintMenuObject class | hintsys.t[181]

A basic hint menu object. This is an abstract base class that encapsulates some behavior common to different hint menu classes.

`class HintMenuObject : object`

Superclass Tree (in declaration order)

`HintMenuObject`
`object`

Subclass Tree

`HintMenuObject`
`Goal`
`HintLongTopicItem`
`HintMenu`
`TopHintMenu`

Global Objects

(none)

Summary of Properties

`topicOrder`

Summary of Methods

`compareForTopicSort`

Properties

`topicOrder` | `hintsys.t[191]`

The topic order. When we're about to show a list of open topics, we'll sort the list in ascending order of this property, then in ascending order of title. By default, we set this order value to 1000; if individual goals don't override this, then they'll simply be sorted lexically by topic name. This can be used if there's some basis other than alphabetical order for sorting the list.

Methods

`compareForTopicSort (other)` | `hintsys.t[202]`

Compare this goal to another, for the purposes of sorting a list of topics. Returns a positive number if this goal sorts after the other one, a negative number if this goal sorts before the other one, 0 if the relative order is arbitrary.

By default, we'll sort by topicOrder if the topicOrder values are different, otherwise alphabetically by title.

Adv3Lite Library Reference Manual
Generated on 25/04/2024 from adv3Lite version 2.0