Files
KSpigot/docs/-k-spigot/net.axay.kspigot.gui/-g-u-i/index.html
2020-12-23 04:21:44 +01:00

190 lines
22 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>GUI</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">
<div id="logo"></div>
<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/pages.js"></script>
<script type="text/javascript" src="../../../scripts/main.js"></script>
<div class="main-content" id="content" pageIds="net.axay.kspigot.gui/GUI///PointingToDeclaration//-327088158">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="../index.html">net.axay.kspigot.gui</a>/<a href="index.html">GUI</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>G</span><wbr></wbr><span>U</span><wbr></wbr><span>I</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">abstract class <a href="index.html">GUI</a>&lt;<a href="index.html">T</a> : <a href="../-for-inventory/index.html">ForInventory</a>&gt;(data: <a href="../-g-u-i-data/index.html">GUIData</a>&lt;<a href="index.html">T</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 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="Inheritors">Inheritors</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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="close-g-u-i.html">closeGUI</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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 fun <a href="close-g-u-i.html">closeGUI</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.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUI%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a>Closes this GUI for all viewers and unregisters all instances.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="equals" id="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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">open operator fun <a href="../../net.axay.kspigot.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">equals</a>(other: <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/-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>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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-all-instances.html">getAllInstances</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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 fun <a href="get-all-instances.html">getAllInstances</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a>&lt;<a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.html">T</a>&gt;&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="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a>Returns all active instances of this GUI.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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-instance.html">getInstance</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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 fun <a href="get-instance.html">getInstance</a>(player: <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>): <a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.html">T</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="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUI%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" data-filterable-set=":dokkaHtml/main"></a>Returns the instance beloning to the given player.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="hashCode" id="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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">open fun <a href="../../net.axay.kspigot.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</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="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" anchor-label="toString" id="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158" 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.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158"></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">open fun <a href="../../net.axay.kspigot.utils/-firework-effect-builder/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-327088158">toString</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>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="%5Bnet.axay.kspigot.gui%2FGUI%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-327088158" anchor-label="data" id="%5Bnet.axay.kspigot.gui%2FGUI%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-327088158" 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="data.html">data</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUI%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-327088158"></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.gui%2FGUI%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-327088158" anchor-label="data" id="%5Bnet.axay.kspigot.gui%2FGUI%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-327088158" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="data.html">data</a>: <a href="../-g-u-i-data/index.html">GUIData</a>&lt;<a href="index.html">T</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>
<h2 class="">Inheritors</h2>
<div class="table" data-togglable="Inheritors"><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158" anchor-label="GUIShared" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158" 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="../-g-u-i-shared/index.html">GUIShared</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIIndividual%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158" anchor-label="GUIIndividual" id="%5Bnet.axay.kspigot.gui%2FGUIIndividual%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158" 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="../-g-u-i-individual/index.html">GUIIndividual</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIIndividual%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F-327088158"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>