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
23218c36a6
Slimefun4/docs/io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html

434 lines
22 KiB
HTML
Raw Normal View History

[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<!DOCTYPE HTML>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- NewPage -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<html lang="en">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<head>
[CI skip] Updated Javadocs
2020-03-22 15:48:23 +00:00
<!-- Generated by javadoc (9.0.4.1) on Sun Mar 22 15:48:18 UTC 2020 -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<title>GEOResource (Slimefun4 - Javadocs)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
[CI skip] Updated Javadocs
2020-03-22 15:48:23 +00:00
<meta name="dc.created" content="2020-03-22">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<script type="text/javascript" src="../../../../../../script.js"></script>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
parent.document.title="GEOResource (Slimefun4 - Javadocs)";
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
}
}
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";
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
var pathtoroot = "../../../../../../";loadScripts(document, 'script');</script>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<div class="topNav"><a id="navbar.top">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="navbar.top.firstrow">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<li><a href="../../../../../../index-all.html">Index</a></li>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<ul class="navListSearch">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="skip.navbar.top">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- ======== START OF CLASS DATA ======== -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<main role="main">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div class="header">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/package-summary.html">io.github.thebusybiscuit.slimefun4.api.geo</a></div>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<dd><code><a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true" title="class or interface in org.bukkit">Keyed</a></code></dd>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</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>
[CI skip] Refactoring, documentation, reduced technical debt
2020-03-07 13:52:33 +00:00
<div class="block">A <a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" title="interface in io.github.thebusybiscuit.slimefun4.api.geo"><code>GEOResource</code></a> is a virtual resource that can be thought of as world-gen.
However it cannot be found in a <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/World.html?is-external=true" title="class or interface in org.bukkit"><code>World</code></a>.
This resource only exists in memory and can be retrieved through a <a href="../../../../../../io/github/thebusybiscuit/slimefun4/implementation/items/geo/GEOMiner.html" title="class in io.github.thebusybiscuit.slimefun4.implementation.items.geo"><code>GEOMiner</code></a>
or similar devices.
A <a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html" title="interface in io.github.thebusybiscuit.slimefun4.api.geo"><code>GEOResource</code></a> can be detected via the <a href="../../../../../../io/github/thebusybiscuit/slimefun4/implementation/items/geo/GEOScanner.html" title="class in io.github.thebusybiscuit.slimefun4.implementation.items.geo"><code>GEOScanner</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>TheBusyBiscuit</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/ResourceManager.html" title="class in io.github.thebusybiscuit.slimefun4.api.geo"><code>ResourceManager</code></a>,
<a href="../../../../../../io/github/thebusybiscuit/slimefun4/implementation/items/geo/GEOMiner.html" title="class in io.github.thebusybiscuit.slimefun4.implementation.items.geo"><code>GEOMiner</code></a>,
<a href="../../../../../../io/github/thebusybiscuit/slimefun4/implementation/items/geo/GEOScanner.html" title="class in io.github.thebusybiscuit.slimefun4.implementation.items.geo"><code>GEOScanner</code></a></dd>
</dl>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<section role="region">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<ul class="blockList">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="method.summary">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<h3>Method Summary</h3>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<table class="memberSummary">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><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>&#8203;(<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></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getItem--">getItem</a></span>&#8203;()</code></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getMaxDeviation--">getMaxDeviation</a></span>&#8203;()</code></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div class="block">Returns how much the value may deviate from the default supply (positive only).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getName--">getName</a></span>&#8203;()</code></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div class="block">Returns the name of this resource (e.g.</div>
</td>
</tr>
<tr id="i4" class="altColor">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#getName-org.bukkit.entity.Player-">getName</a></span>&#8203;(<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></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#isObtainableFromGEOMiner--">isObtainableFromGEOMiner</a></span>&#8203;()</code></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../io/github/thebusybiscuit/slimefun4/api/geo/GEOResource.html#register--">register</a></span>&#8203;()</code></th>
<td class="colLast">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div class="block">Registers this GEO Resource</div>
</td>
</tr>
</table>
<ul class="blockList">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="methods.inherited.from.class.org.bukkit.Keyed">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
</section>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<section role="region">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<ul class="blockList">
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="method.detail">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<h3>Method Detail</h3>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="getDefaultSupply-org.bukkit.World.Environment-org.bukkit.block.Biome-">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultSupply</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre>int&nbsp;getDefaultSupply&#8203;(<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,
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="getMaxDeviation--">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxDeviation</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre>int&nbsp;getMaxDeviation&#8203;()</pre>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="getName--">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName&#8203;()</pre>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="getItem--">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<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&#8203;()</pre>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="isObtainableFromGEOMiner--">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isObtainableFromGEOMiner</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre>boolean&nbsp;isObtainableFromGEOMiner&#8203;()</pre>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="register--">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre>default&nbsp;void&nbsp;register&#8203;()</pre>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<div class="block">Registers this GEO Resource</div>
</li>
</ul>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="getName-org.bukkit.entity.Player-">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getName</h4>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<pre>default&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName&#8203;(<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>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
</section>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</li>
</ul>
</div>
</div>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
</main>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- ========= END OF CLASS DATA ========= -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<footer role="contentinfo">
<nav role="navigation">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<div class="bottomNav"><a id="navbar.bottom">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="navbar.bottom.firstrow">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<li><a href="../../../../../../index-all.html">Index</a></li>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</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>
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
<a id="skip.navbar.bottom">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
[CI skip] Updated Javadocs
2020-03-21 18:04:45 +00:00
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</footer>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</body>
</html>
Copy Permalink