LanguageExtension

class omni.kit.language.core.scripts.language.LanguageExtension

Bases: IExt

Font & Language support class

Methods

__init__(self)
get_language_info(locale_id)	Get registered information about language.
get_locale_id()
get_locales()	Get list of registered locale names.
has_font_changed(locale_id)	Compares default_locale_id with locale_id and returns True/False.
on_shutdown()
on_startup(ext_id)
register_language(locale_info, font_path, ...)	Registers a new language.
switch_language()
unregister_language(locale_id)	Unregisters a new language.

__init__(self: omni.ext._extensions.IExt) → None

get_language_info(locale_id) → dict

Get registered information about language.

Parameters:

locale_id (str) – EG. “en_US”

Returns:

locale info dictionary (dict)

get_locales() → list[str]

Get list of registered locale names.

Returns:

list of known locales (list[str])

has_font_changed(locale_id: str) → bool

Compares default_locale_id with locale_id and returns True/False.

Parameters:

locale_id (str) – EG. “en_US”

Returns:

True is locale info is different to current locale info (bool)

register_language(

locale_info: tuple,

font_path: str,

font_scale: float,

regions: list[str],

pangram: str,

font_overresolution_size: float = None,

) → bool

Registers a new language. (Currently on has font support)

This function added a new language to the pool of known languages and then attempts to switch to the new language if current locale_id matches given locale_id.

Parameters:

• locale_info (tuple) – contains locale_id, language name and localized language name.

• font_path (str) – path to a font file that will be used instead of default font.

• font_scale (float) – additional scaling to font.

• regions (list[str]) – list of region files that contain the characters to be used. See kit/source/extensions/omni.kit.renderer.imgui/data/regions/ for an example.

• pangram (str) – string containing all the letters in the alphabet. EG. “The quick brown fox jumps over the lazy dog”.

• font_overresolution_size (float) – override largest font size from default 100. Useful for large font ranges.

Returns:

True on success or False in error.

unregister_language(locale_id: str) → bool

Unregisters a new language.

This function removed a language to the pool of known languages.

Parameters:

locale_id (str) – EG. “en_US”

Returns:

True on success or False on failure.