gui.getLocalizedString

Extracts a translated string from XML.

Prototype

  1. sString = gui.getLocalizedString ( sString )

Description

The XML structure looks like this:



    <localisation>

        <language locale="default">

            <sentence key="Rollout_General" value="general"/>

        </language> 

        <language locale="FR-fr">

            <sentence key="Rollout_General" value="général"/>

        </language> 

        <language locale="IT-it">

            <sentence key="Rollout_General" value="generalo"/>

        </language>

    </localisation >

Parameters

sString - english base string

Return values

sString - localized version of the string based on the user preferences

Sample

  1. hud.setLabelText ( hNoPreviewAvailable, gui.getLocalizedString ( "No preview" ) )

Available since ShiVa 2.0