LState class | english.t[1919]

LState is the language-specific base class for State objects.

[Required]

`class LState : object`

Superclass Tree (in declaration order)

`LState`
`object`

Subclass Tree

`LState`
`State`

Global Objects

(none)

Summary of Properties

`additionalInfo`

Summary of Methods

`addToName getAdditionalInfo initWord`

Properties

`additionalInfo` | `english.t[1956]`

Additional info to be added to the item name when it appears in a listing and is in the corresponding state

Methods

`addToName (obj, str)` | `english.t[1927]`

Add the state name to an object name under construction. 'obj' is the object, and 'str' the object name being built. This adds the appropriate adjective for the state to the name.

[Required]

`getAdditionalInfo (obj)` | `english.t[1963]`

Get the string providing additional info about this object when it's in a particular state (such as '(providing light)', the only additional state info actually defined in the English library)

`initWord (w)` | `english.t[1946]`

Initialize a state adjective. The base library calls this during preinit for each word, given as a string. The language module must define this routine, but it doesn't have to do anything. The English version adds the word to the dictionary, so that the spelling corrector can recognize it.

[Required]

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