Phantasmal Site > Phantasmal API > API Listing > to_string

API Function: to_string

Summary:

convert the Phrase to a string in the correct locale

Defined In LPC Object:

/usr/common/lib/intl_phrase.c

Prototype:

string to_string(object user)

Can Be Called By:

Anybody

Description:

Return an appropriate string for this Phrase as the given user should see it. Since Phrases are localizable, the user object may be used to supply the locale (English, Spanish, French, etc), the terminal settings or other information, which is in turn used to customize the Phrase. Normally in-game information contained in a body or mobile is not used, that occurs before the information is converted to a Phrase.

This function isn't access-protected. You should access-protect your version of this and all other inherited functions, including upgraded() and destructed().

Return Value:

The string described above.

Errors:

Undefined locale or other setting can cause an error, as can access violations.

See Also:

get_content_by_lang