79 lines
12 KiB
HTML
79 lines
12 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Localization</title>
|
|
<link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="KSpigot::net.axay.kspigot.localization/Localization///PointingToDeclaration//-1946532649">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../../index.html">KSpigot</a>/<a href="../index.html">net.axay.kspigot.localization</a>/<a href="index.html">Localization</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Localization</span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">object <a href="index.html">Localization</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Handles localization of strings using java <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>s.</p><p class="paragraph">Message property files should reside in <code>src/main/resources</code> named <code>messages_locale.properties</code>, where <code>locale</code> is formatted as returned by <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html#toString--">Locale.toString</a>.</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%2C+net.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="get" id="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%2C+net.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
|
|
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="get.html">get</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%2C+net.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">fun <a href="get.html">get</a>(locale: <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html">Locale</a>, key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="get" id="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="get" id="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>Returns the localized string for <a href="get.html">key</a></div></div>
|
|
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">fun <a href="get.html">get</a>(locale: <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html">Locale</a>, key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, vararg args: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="get" id="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="get" id="%5Bnet.axay.kspigot.localization%2FLocalization%2Fget%2F%23java.util.Locale%23kotlin.String%23kotlin.Array%5Bkotlin.Pair%5Bkotlin.String%2Ckotlin.Any%3F%5D%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>Additionally formats the localized string with the named <a href="get.html">args</a>, which are represented as <code>{argumentName}</code> in the translations</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Properties</h2>
|
|
<div class="table" data-togglable="Properties"><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="localeProvider" id="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
|
|
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="locale-provider.html">localeProvider</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="localeProvider" id="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">var <a href="locale-provider.html">localeProvider</a>: (<span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>) -> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html">Locale</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="localeProvider" id="%5Bnet.axay.kspigot.localization%2FLocalization%2FlocaleProvider%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>This function determines which locale is used for a player, by default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html#US--">Locale.US</a> is always returned.</div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|