Files
KSpigot/docs/-k-spigot/net.axay.kspigot.ipaddress/index.html
2021-05-15 22:14:07 +02:00

206 lines
22 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>net.axay.kspigot.ipaddress</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.ipaddress////PointingToDeclaration//769193423">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.ipaddress</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Package net.</span><wbr></wbr><span>axay.</span><wbr></wbr><span>kspigot.</span><wbr></wbr><span>ipaddress</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="-1032641336%2FClasslikes%2F769193423" anchor-label="BadIPDetectionResult" id="-1032641336%2FClasslikes%2F769193423" 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="-bad-i-p-detection-result/index.html">BadIPDetectionResult</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1032641336%2FClasslikes%2F769193423"></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">enum <a href="-bad-i-p-detection-result/index.html">BadIPDetectionResult</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;<a href="-bad-i-p-detection-result/index.html">BadIPDetectionResult</a>&gt; <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>
</div>
</div>
</div>
</div>
</div>
<a data-name="2100784008%2FClasslikes%2F769193423" anchor-label="BadIPDetectionService" id="2100784008%2FClasslikes%2F769193423" 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="-bad-i-p-detection-service/index.html">BadIPDetectionService</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2100784008%2FClasslikes%2F769193423"></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">abstract class <a href="-bad-i-p-detection-service/index.html">BadIPDetectionService</a>(name: <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>
</div>
</div>
</div>
</div>
</div>
<a data-name="1640954866%2FClasslikes%2F769193423" anchor-label="BadIPDetector" id="1640954866%2FClasslikes%2F769193423" 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="-bad-i-p-detector/index.html">BadIPDetector</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1640954866%2FClasslikes%2F769193423"></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">class <a href="-bad-i-p-detector/index.html">BadIPDetector</a>(services: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;<a href="-bad-i-p-detection-service/index.html">BadIPDetectionService</a>&gt;)<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>
</div>
</div>
</div>
</div>
</div>
<a data-name="669124909%2FClasslikes%2F769193423" anchor-label="IPAddressData" id="669124909%2FClasslikes%2F769193423" 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="-i-p-address-data/index.html">IPAddressData</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="669124909%2FClasslikes%2F769193423"></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">class <a href="-i-p-address-data/index.html">IPAddressData</a>(json: <span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span>)<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>
</div>
</div>
</div>
</div>
</div>
<a data-name="-330093387%2FClasslikes%2F769193423" anchor-label="IPAddressDataLanguage" id="-330093387%2FClasslikes%2F769193423" 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="-i-p-address-data-language/index.html">IPAddressDataLanguage</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-330093387%2FClasslikes%2F769193423"></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">enum <a href="-i-p-address-data-language/index.html">IPAddressDataLanguage</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;<a href="-i-p-address-data-language/index.html">IPAddressDataLanguage</a>&gt; <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>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-1238711596%2FFunctions%2F769193423" anchor-label="checkIP" id="-1238711596%2FFunctions%2F769193423" 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="check-i-p.html">checkIP</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1238711596%2FFunctions%2F769193423"></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 <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>.<a href="check-i-p.html">checkIP</a>(detector: <a href="-bad-i-p-detector/index.html">BadIPDetector</a> = BadIPDetector.DEFAULT, breakOnHit: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = true): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="-bad-i-p-detection-service/index.html">BadIPDetectionService</a>, <a href="-bad-i-p-detection-result/index.html">BadIPDetectionResult</a>&gt;<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="-1238711596%2FFunctions%2F769193423" anchor-label="checkIP" id="-1238711596%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="-1238711596%2FFunctions%2F769193423" anchor-label="checkIP" id="-1238711596%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Checks if the IP address of the player is not a normal residential address.</div></div>
</div>
</div>
</div>
</div>
<a data-name="249946133%2FFunctions%2F769193423" anchor-label="hasBadIP" id="249946133%2FFunctions%2F769193423" 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="has-bad-i-p.html">hasBadIP</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="249946133%2FFunctions%2F769193423"></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 <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>.<a href="has-bad-i-p.html">hasBadIP</a>(detector: <a href="-bad-i-p-detector/index.html">BadIPDetector</a> = BadIPDetector.DEFAULT): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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="249946133%2FFunctions%2F769193423" anchor-label="hasBadIP" id="249946133%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="249946133%2FFunctions%2F769193423" anchor-label="hasBadIP" id="249946133%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Checks if the IP address of the player is not a normal residential address.</div></div>
</div>
</div>
</div>
</div>
<a data-name="-220253109%2FFunctions%2F769193423" anchor-label="ipAddressData" id="-220253109%2FFunctions%2F769193423" 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="ip-address-data.html">ipAddressData</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-220253109%2FFunctions%2F769193423"></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 <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>.<a href="ip-address-data.html">ipAddressData</a>(language: <a href="-i-p-address-data-language/index.html">IPAddressDataLanguage</a> = IPAddressDataLanguage.ENGLISH): <a href="-i-p-address-data/index.html">IPAddressData</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>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="-2048837304%2FProperties%2F769193423" anchor-label="ipAddressData" id="-2048837304%2FProperties%2F769193423" 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="ip-address-data.html">ipAddressData</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2048837304%2FProperties%2F769193423"></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="-2048837304%2FProperties%2F769193423" anchor-label="ipAddressData" id="-2048837304%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>.<a href="ip-address-data.html">ipAddressData</a>: <a href="-i-p-address-data/index.html">IPAddressData</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="-2048837304%2FProperties%2F769193423" anchor-label="ipAddressData" id="-2048837304%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1588592856%2FProperties%2F769193423" anchor-label="ipAddressOrNull" id="-1588592856%2FProperties%2F769193423" 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="ip-address-or-null.html">ipAddressOrNull</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1588592856%2FProperties%2F769193423"></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="-1588592856%2FProperties%2F769193423" anchor-label="ipAddressOrNull" id="-1588592856%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>.<a href="ip-address-or-null.html">ipAddressOrNull</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 class="brief "><a data-name="-1588592856%2FProperties%2F769193423" anchor-label="ipAddressOrNull" id="-1588592856%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a></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>