Skip to content

feat: expand definition of $.Localize #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsa96 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: expand definition of $.Localize #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions shared/apis.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,13 +265,18 @@ declare namespace $ {

/**
* Localizes a string.
* If provided a panel, uses the dialog variables assigned to that panel in the output string.
* @example
* $.Localize('#Weapon_StickybombLauncher'); // Returns "Kleefbommenwerper" in Dutch in Momentum
* @example
* $.Localize('#SomeNonexistentToken'); // Returns "#SomeNonexistentToken"
* @example
* const panel = $.CreatePanel('Panel', $.GetContextPanel(), '');
* panel.SetDialogVariableInt('horses', 5);
* $.Localize('#HorseCount', panel); // If #HorseCount is "I have %d horse", returns "I have 5 horses"
* @returns Localized string in the current language, if exists, otherwise the provided argument.
* @see [Example](https://github.com/momentum-mod/panorama/blob/721f39fe40bad57cd93943278d3a3c857e9ae9d7/scripts/hud/status.js#L47)
*/
function Localize(str: string): string;
function Localize(str: string, panel?: GenericPanel): string;

/** Localize a string, but return empty string if the localization token is not found */
function LocalizeSafe(str: string): string;
Expand Down