LTEXT

From SC4D Encyclopaedia
Revision as of 20:09, 8 September 2012 by sc4e>Whatevermind (reorganized a bit, split non-comp and compressed files specs - the more I look at them, the more they are different beasts)
Jump to navigation Jump to search

LTEXT or Language Text files are a Unicode text format used by SimCity 4 to give language specific text strings simply and quickly for use in any part of the world. Unicode of course makes this much easier since the vast number of characters can't always be written in standard text. LTEXT files cover everything from news to building and prop names to tool names in the game. They are queried by Instance ID, so make sure your instance is unique when creating new ones!

LTEXT files are partially controlled by the Delocalizers file, which gives the game instructions about converting text into the local language, or not.

LTEXT files are also related to the User Visible Name Key and Item Description Key in exemplars. They can also contain HTML code that is used by the game. LTEXTs can also contain variables, to be filled in by the game with the appropriate value.

LTEXT files can be found in SimcityLocale.dat, as well as both Maxis and user-created plugin files. They are generally seen as an LTEXT or XA file by Reader.

Format Specification

Non-Compressed Files

WORD - Number of 2 byte characters in the LTEXT.
WORD - 0x0010 - Start of Text control character.
WORD - (Repeating) - 2 Bytes for each character, simply use the Unicode character for the
       value of these two bytes to see its visible in-game form.

In English, decoding this is easy since non-compressed files will appear as an English character followed by a period in most hex editors. Other languages may be harder, i.e. Chinese, Korean. Compressed files do not have this same benefit.

Compressed Files

WORD    - Size of compressed file.
WORD    - 0x0000
WORD    - 0x10FB - Indicates QFS compression.
6 BYTES - Compression related information - only found in compressed LTEXT files.
WORD    - 0x0010 - Start of Text control character.
Data    - Compressed text data.

PHP Function

Here is a PHP function that returns the string enclosed in an LTEXT file:

function ltextThing($data){
/*ExemplarFile
	typeID: 6534284a
	$value = the 'content' array key*/

	$thing = str_split($data);
	foreach ($thing as $char => $word){
		if ($char % 2 == int and $char != 2)
			$return .= $word;
	}
return $return;	
}