Skip to content

String functions

Functions to manipulate and format strings.

Str_Format

Returns formatted string using format specifiers

Format specifiers:

  • %s - inserts a string
  • %i - inserts an integer number
  • %x - inserts an integer in hexadecimal
  • %f - inserts a floating point number
  • %b - inserts a logical expression
  • %p - inserts a pointer
1
func string Str_Format( var string format, ... ) {};
  • return - formatted string

Examples

Very powerful function, can be used to streamline strings used in the scripts as well as optimize them for translations.

Define constants containing the string with format specifiers. 

1
2
const string MENU_SAVE = "Slot %i - press ENTER to save in this slot.";
const string MENU_LOAD = "Slot %i - press ENTER to load saved game.";
Then define two format functions as such: 
1
2
3
4
func string GetSaveSlotString (var int number)
{
    return Str_format(MENU_SAVE, number);
};

1
2
3
4
func string GetLoadSlotString (var int number)
{
    return Str_format(MENU_LOAD, number);
};

Tip

Since the whole translatable string is saved in one constant, it is very easy for translators to change the word order. This was not possible to do without code change to the ConcatStrings function calls within the scripts.
With this simple change, translators have to translate only 2 strings instead of 30 (15 + 15 slots) and only 2 strings are compiled into the compiled Menu.dat file.

Str_GetLocalizedString

Returns a string in the current language, otherwise in English. Arguments MUST be encoded in UTF-8! The result string will be converted to appropriate ANSI string.

1
2
3
4
func string Str_GetLocalizedString( var string russian,
                                    var string english,
                                    var string german,
                                    var string polish ) {};
  • russian - Russian string
  • english - English string
  • german - German string
  • polish - Polish string
  • return - string in the current language

Str_GetLocalizedStringEx

Returns a string in the current language, otherwise in English. Offers additional languages

1
2
3
4
5
6
7
8
func string Str_GetLocalizedStringEx(   var string russian,
                                        var string english,
                                        var string german,
                                        var string polish,
                                        var string romanian,
                                        var string italian,
                                        var string czech,
                                        var string spanish ) {};
  • russian - Russian string
  • english - English string
  • german - German string
  • polish - Polish string
  • romanian - Romanian string
  • italian - Italian string
  • czech - Czech string
  • spanish - Spanish string
  • return - string in the current language

Str_UTF8_to_ANSI

Converts UTF-8 string into an ANSI string with codePage

1
func string Str_UTF8_to_ANSI( var string utf8, var int codePage ) {};
  • utf8 - string encoded in UTF8
  • codePage - codePage id, can be obtained from Str_GetCurrentCP
  • return -

Str_GetCurrentCP

Return the code page corresponding to the current language set in the Union System 

1
func int Str_GetCurrentCP() {};
  • return - code page corresponding to the current language

Str_GetLength

Returns the length of a string

1
func int Str_GetLength( var int str ) {};
  • str - string to be measured
  • return - length of the string