Help home › Special Plugin Types › Language Plugins › FH_GetAgeRangeText (entry-point)

Language Plugins

FH_GetAgeRangeText (entry-point)

Description

This entry-point is called to render age range information into text, in a specified format, in the output language.

Syntax

strRenderedAgeRangeText = FH_GetAgeRangeText(strFormat, iYear1, iYear2, bMale, strName)

Parameters

strFormat
String.  The date format required.  Possible values are "SENTENCE", "ADVERB" or "ADJECTIVE" - see table below:
SENTENCE Use the name supplied, if there is one, to create a sentence in the output language, giving the age range for the person.  If no name is supplied, use an appropriate pronoun instead.  e.g. "John was 45-49 years old" or "he was 45-49 years old".
ADVERB
Create an adverbial phrase like "aged 45-49"
ADJECTIVE
Create an adjectival phrase like "age 45-49"
iYear1
Integer.  The starting year for the range.
iYear2
Integer.  The ending year for the range.
bMale
Boolean.  True if the person is male.
strName
String.  May be an empty string.  If supplied it is the person's name.  Only used when constructing sentences.

Returns

strRenderedAgeText
String. The rendered age text. Return nil if unable to render a particular age value.

Example

 
function FH_GetAgeRangeText(sFormat, iYear1, iYear2, bMale, sName)
    local sText;
    if sFormat == "SENTENCE" then
        sText = GetSentenceStart(bMale, sName, true);
        sText = sText .. iYear1 .. "-" .. iYear2 .. " ans";
    elseif sFormat == "ADVERB" then
        if bMale then
            sText = "âgé de ";
        else
            sText = "âgée de ";
        end
        sText = sText .. iYear1 .. "-" .. iYear2 .. " ans";
    elseif sFormat == "ADJECTIVE" then
        sText = iYear1 .. "-" .. iYear2 .. " ans";
    end
    return sText;
end

Links to

Linked from

No other help topics link here yet.