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

204 lines
23 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>LocationArea</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.extensions.geometry/LocationArea///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.extensions.geometry</a>/<a href="index.html">LocationArea</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Location</span><wbr></wbr><span>Area</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">class <a href="index.html">LocationArea</a>(loc1: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</span>, loc2: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</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 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><button class="section-tab" data-togglable="Extensions">Extensions</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-185581736%2FFunctions%2F769193423" anchor-label="isInArea" id="-185581736%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="is-in-area.html">isInArea</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-185581736%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 <a href="is-in-area.html">isInArea</a>(loc: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</span>, check3d: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = true, tolerance: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 0): <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>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="1757886867%2FProperties%2F769193423" anchor-label="loc1" id="1757886867%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="loc1.html">loc1</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1757886867%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="1757886867%2FProperties%2F769193423" anchor-label="loc1" id="1757886867%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">var <a href="loc1.html">loc1</a>: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</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>
<a data-name="1788906674%2FProperties%2F769193423" anchor-label="loc2" id="1788906674%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="loc2.html">loc2</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1788906674%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="1788906674%2FProperties%2F769193423" anchor-label="loc2" id="1788906674%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">var <a href="loc2.html">loc2</a>: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</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>
<a data-name="-780439576%2FProperties%2F769193423" anchor-label="maxLoc" id="-780439576%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="max-loc.html">maxLoc</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-780439576%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="-780439576%2FProperties%2F769193423" anchor-label="maxLoc" id="-780439576%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="max-loc.html">maxLoc</a>: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</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>
<a data-name="969007062%2FProperties%2F769193423" anchor-label="minLoc" id="969007062%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="min-loc.html">minLoc</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="969007062%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="969007062%2FProperties%2F769193423" anchor-label="minLoc" id="969007062%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="min-loc.html">minLoc</a>: <span data-unresolved-link="org.bukkit/Location///PointingToDeclaration/">Location</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>
<a data-name="197779779%2FProperties%2F769193423" anchor-label="simpleLocationPair" id="197779779%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="simple-location-pair.html">simpleLocationPair</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="197779779%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="197779779%2FProperties%2F769193423" anchor-label="simpleLocationPair" id="197779779%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">var <a href="simple-location-pair.html">simpleLocationPair</a>: <a href="../-simple-location-pair/index.html">SimpleLocationPair</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>
<a data-name="-1960350446%2FProperties%2F769193423" anchor-label="touchedChunks" id="-1960350446%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="touched-chunks.html">touchedChunks</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1960350446%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="-1960350446%2FProperties%2F769193423" anchor-label="touchedChunks" id="-1960350446%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="touched-chunks.html">touchedChunks</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a>&lt;<span data-unresolved-link="org.bukkit/Chunk///PointingToDeclaration/">Chunk</span>&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>
<a data-name="1259924388%2FProperties%2F769193423" anchor-label="world" id="1259924388%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="world.html">world</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1259924388%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="1259924388%2FProperties%2F769193423" anchor-label="world" id="1259924388%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="world.html">world</a>: <span data-unresolved-link="org.bukkit/World///PointingToDeclaration/">World</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>
<h2 class="tabbedcontent">Extensions</h2>
<div class="table" data-togglable="Extensions"><a data-name="-296099962%2FExtensions%2F769193423" anchor-label="entities" id="-296099962%2FExtensions%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="../../net.axay.kspigot.structures/entities.html">entities</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-296099962%2FExtensions%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">val <a href="index.html">LocationArea</a>.<a href="../../net.axay.kspigot.structures/entities.html">entities</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a>&lt;<span data-unresolved-link="org.bukkit.entity/Entity///PointingToDeclaration/">Entity</span>&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="1044756078%2FExtensions%2F769193423" anchor-label="fillBlocks" id="1044756078%2FExtensions%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="../../net.axay.kspigot.structures/fill-blocks.html">fillBlocks</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1044756078%2FExtensions%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">val <a href="index.html">LocationArea</a>.<a href="../../net.axay.kspigot.structures/fill-blocks.html">fillBlocks</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a>&lt;<span data-unresolved-link="org.bukkit.block/Block///PointingToDeclaration/">Block</span>&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="1328971695%2FExtensions%2F769193423" anchor-label="loadStructure" id="1328971695%2FExtensions%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="../../net.axay.kspigot.structures/load-structure.html">loadStructure</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1328971695%2FExtensions%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 <a href="index.html">LocationArea</a>.<a href="../../net.axay.kspigot.structures/load-structure.html">loadStructure</a>(includeBlocks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = true, includeEntities: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="../../net.axay.kspigot.structures/-structure/index.html">Structure</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>
</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>