Skip to content
This repository was archived by the owner on Jun 9, 2023. It is now read-only.

cp.localized.md

Latest commit

 

History

History
22 lines (16 loc) · 1.4 KB

cp.localized.md

File metadata and controls

22 lines (16 loc) · 1.4 KB

docs » cp.localized

Helps look up localized names for folders.

API Overview

API Documentation

Functions

getLocalizedName

Signature cp.localized.getLocalizedName(path[, locale]) -> string, string
Type Function
Description Returns the localized name for the path in the specified locale. If all else fails, the
Parameters
  • path - The full path to the folder
  • locale - The locale to retrieve the name for.
Returns
  • The localized name, or name if not available.
  • The original name, minus .localized
Notes
  • This function will automatically convert a colon to a dash when localising.