mirror/Slimefun4
mirror/Slimefun4
1
Fork 0
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 11:45:51 +00:00
Code Releases Activity
4255aaa444
Slimefun4/docs/io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html

368 lines
17 KiB
HTML
Raw Normal View History

[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
[CI skip] Refactoring + documentation
2020-03-06 00:57:50 +00:00
<!-- Generated by javadoc (1.8.0_111) on Fri Mar 06 01:55:53 CET 2020 -->
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<title>GEOResource</title>
[CI skip] Updated documentation
2020-03-06 00:22:54 +00:00
<meta name="date" content="2020-03-06">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GEOResource";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6,"i6":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GEOResource.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/ResourceManager.html" title="class in io.github.thebusybiscuit.slimefun4.api.geo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" target="_top">Frames</a></li>
<li><a href="GEOResource.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">io.github.thebusybiscuit.slimefun4.api.geo</div>
<h2 title="Interface GEOResource" class="title">Interface GEOResource</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true" title="class or interface in org.bukkit">Keyed</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GEOResource</span>
extends <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true" title="class or interface in org.bukkit">Keyed</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getDefaultSupply-org.bukkit.World.Environment-org.bukkit.block.Biome-">getDefaultSupply</a></span>(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/World.Environment.html?is-external=true" title="class or interface in org.bukkit">World.Environment</a>&nbsp;environment,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Biome.html?is-external=true" title="class or interface in org.bukkit.block">Biome</a>&nbsp;biome)</code>
<div class="block">Returns the default supply of this resource in that biome</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemStack.html?is-external=true" title="class or interface in org.bukkit.inventory">ItemStack</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getItem--">getItem</a></span>()</code>
<div class="block">This <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemStack.html?is-external=true" title="class or interface in org.bukkit.inventory"><code>ItemStack</code></a> is used for display-purposes in the GEO Scanner.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getMaxDeviation--">getMaxDeviation</a></span>()</code>
<div class="block">Returns how much the value may deviate from the default supply (positive only).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of this resource (e.g.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getName-org.bukkit.entity.Player-">getName</a></span>(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p)</code>
<div class="block">This method returns a localized name for this <a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" title="interface in io.github.thebusybiscuit.slimefun4.api.geo"><code>GEOResource</code></a> in the
<a href="../../../../../../io/github/thebusybiscuit/slimefun4/core/services/localization/Language.html" title="class in io.github.thebusybiscuit.slimefun4.core.services.localization"><code>Language</code></a> the given <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> selected.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#isObtainableFromGEOMiner--">isObtainableFromGEOMiner</a></span>()</code>
<div class="block">Returns whether this Resource can be obtained using a GEO Miner.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#register--">register</a></span>()</code>
<div class="block">Registers this GEO Resource</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.bukkit.Keyed">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.bukkit.<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true" title="class or interface in org.bukkit">Keyed</a></h3>
<code><a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true#getKey--" title="class or interface in org.bukkit">getKey</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDefaultSupply-org.bukkit.World.Environment-org.bukkit.block.Biome-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultSupply</h4>
<pre>int&nbsp;getDefaultSupply(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/World.Environment.html?is-external=true" title="class or interface in org.bukkit">World.Environment</a>&nbsp;environment,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Biome.html?is-external=true" title="class or interface in org.bukkit.block">Biome</a>&nbsp;biome)</pre>
<div class="block">Returns the default supply of this resource in that biome</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>environment</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/World.Environment.html?is-external=true" title="class or interface in org.bukkit"><code>World.Environment</code></a> this area is currently in (NORMAL / NETHER / THE_END)</dd>
<dd><code>biome</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Biome.html?is-external=true" title="class or interface in org.bukkit.block"><code>Biome</code></a> this area is currently in.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The default supply found in a <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Chunk.html?is-external=true" title="class or interface in org.bukkit"><code>Chunk</code></a> with the given <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Biome.html?is-external=true" title="class or interface in org.bukkit.block"><code>Biome</code></a></dd>
</dl>
</li>
</ul>
<a name="getMaxDeviation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxDeviation</h4>
<pre>int&nbsp;getMaxDeviation()</pre>
<div class="block">Returns how much the value may deviate from the default supply (positive only).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The deviation or spread of the supply</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Returns the name of this resource (e.g. "Oil")</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of this Resource</dd>
</dl>
</li>
</ul>
<a name="getItem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
<pre><a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemStack.html?is-external=true" title="class or interface in org.bukkit.inventory">ItemStack</a>&nbsp;getItem()</pre>
<div class="block">This <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemStack.html?is-external=true" title="class or interface in org.bukkit.inventory"><code>ItemStack</code></a> is used for display-purposes in the GEO Scanner.
But will also determine the Output of the GEO Miner, if it is applicable for that.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemStack.html?is-external=true" title="class or interface in org.bukkit.inventory"><code>ItemStack</code></a> version of this Resource.</dd>
</dl>
</li>
</ul>
<a name="isObtainableFromGEOMiner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isObtainableFromGEOMiner</h4>
<pre>boolean&nbsp;isObtainableFromGEOMiner()</pre>
<div class="block">Returns whether this Resource can be obtained using a GEO Miner.
This will automatically add it to the GEO - Miner.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether you can get obtain this resource using a GEO Miner.</dd>
</dl>
</li>
</ul>
<a name="register--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>default&nbsp;void&nbsp;register()</pre>
<div class="block">Registers this GEO Resource</div>
</li>
</ul>
<a name="getName-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getName</h4>
<pre>default&nbsp;java.lang.String&nbsp;getName(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p)</pre>
<div class="block">This method returns a localized name for this <a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" title="interface in io.github.thebusybiscuit.slimefun4.api.geo"><code>GEOResource</code></a> in the
<a href="../../../../../../io/github/thebusybiscuit/slimefun4/core/services/localization/Language.html" title="class in io.github.thebusybiscuit.slimefun4.core.services.localization"><code>Language</code></a> the given <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> selected.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> to localize the name for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The localized name for this <a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" title="interface in io.github.thebusybiscuit.slimefun4.api.geo"><code>GEOResource</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GEOResource.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/ResourceManager.html" title="class in io.github.thebusybiscuit.slimefun4.api.geo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" target="_top">Frames</a></li>
<li><a href="GEOResource.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Copy Permalink