englishMessageParamsobject
The message parameters object. The language module must provide one instance of MessageParams, to fill in the language-specific list of parameter names and expansion functions.
[Required]
englishMessageParams : MessageParams
Superclass Tree (in declaration order)
englishMessageParams
MessageParams
` object`
Summary of Properties
params sentenceOrder sLetters verbTab
Inherited from MessageParams :
langObj paramTab
Summary of Methods
awkwardEnding cmdInfoReflexive construct
Inherited from MessageParams :
cmdInfo expand findStrParam
Properties
paramsOVERRIDDEN
The English parameter mappings. The base library doesn’t use any of these directly, so parameter names and mappings are entirely up to the language module. The only part of the library that uses the parameters is the library message strings, which are all defined by the language module itself. Other translations are free to use different parameter names, and don’t have to replicate 1-for-1 the parameters defined for English. Translations only have to define the parameters needed for their own library messages (plus any others they want to provide for use by game authors, of course).
[Required]
sentenceOrder
The language’s general sentence order. This should be a string containing the letters S, V, and O in the appropriate order for the language. S is for Subject, V is for Verb, and O is for Object. For example, English is an SVO language, since the general order of an English sentence is Subject Verb Object.
This can be left nil for languages with no prevailing sentence order.
sLetters
Word-ending letter combinations that are awkward to follow with a contracted verb such a ‘ve.
verbTab
verb table - we build this at preinit from the verb parameters
Methods
awkwardEnding (nam)
Does nam end with one of the letter combinations in sLetters, in which case it’s awkward to follow it with a contraction.
cmdInfoReflexive (ctx, srcObj, objProp)
Check for reflexives in cmdInfo. This is called when we see a noun phrase being used as an object of the verb (i.e., in a role other than as the subject of the verb). If appropriate, we can return a reflexive pronoun instead of the noun we’d normally generate. If no reflexive is required, we return nil, and the caller will use the normal noun or pronoun instead.
construct ( )OVERRIDDEN
On construction, fill in the verb parameters from CustomVocab objects.
Adv3Lite Library Reference Manual
Generated on 15/03/2023 from adv3Lite version 1.6.1