EpicKnarvik97/PlotSquared
EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-23 13:46:45 +01:00
Code Issues Projects Releases Wiki Activity
5a842842a2
PlotSquared/doc/com/intellectualcrafters/plot/generator/WorldGenerator.html

572 lines
29 KiB
HTML
Raw Normal View History

Moved folder
2014-11-16 11:14:40 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:52 CET 2014 -->
<title>WorldGenerator</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "WorldGenerator";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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><a href="../../../../com/intellectualcrafters/plot/generator/DefaultPlotWorld.html"
title="class in com.intellectualcrafters.plot.generator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/generator/XPopulator.html"
title="class in com.intellectualcrafters.plot.generator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/generator/WorldGenerator.html" target="_top">Frames</a>
</li>
<li><a href="WorldGenerator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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><a href="#nested_classes_inherited_from_class_org.bukkit.generator.ChunkGenerator">Nested</a>&nbsp;|&nbsp;
</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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">com.intellectualcrafters.plot.generator</div>
<h2 title="Class WorldGenerator" class="title">Class WorldGenerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.bukkit.generator.ChunkGenerator</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html"
title="class in com.intellectualcrafters.plot.object">com.intellectualcrafters.plot.object.PlotGenerator</a>
</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.plot.generator.WorldGenerator</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">WorldGenerator</span>
extends <a href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html"
title="class in com.intellectualcrafters.plot.object">PlotGenerator</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a
name="nested_classes_inherited_from_class_org.bukkit.generator.ChunkGenerator">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from
class&nbsp;org.bukkit.generator.ChunkGenerator</h3>
<code>org.bukkit.generator.ChunkGenerator.BiomeGrid</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#WorldGenerator(java.lang.String)">WorldGenerator</a></strong>(java.lang.String&nbsp;world)</code>
<div class="block">Initialize variables, and create plotworld object used in
calculations
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#canSpawn(org.bukkit.World,%20int,%20int)">canSpawn</a></strong>(org.bukkit.World&nbsp;world,
int&nbsp;x,
int&nbsp;z)</code>
<div class="block">Allow spawning everywhere</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short[][]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#generateExtBlockSections(org.bukkit.World,%20java.util.Random,%20int,%20int,%20org.bukkit.generator.ChunkGenerator.BiomeGrid)">generateExtBlockSections</a></strong>(org.bukkit.World&nbsp;world,
java.util.Random&nbsp;random,
int&nbsp;cx,
int&nbsp;cz,
org.bukkit.generator.ChunkGenerator.BiomeGrid&nbsp;biomes)</code>
<div class="block">This part is a fucking mess. - Refer to a proper tutorial if you
would
like to learn how to make a world generator
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;org.bukkit.generator.BlockPopulator&gt;</code>
</td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#getDefaultPopulators(org.bukkit.World)">getDefaultPopulators</a></strong>(org.bukkit.World&nbsp;world)</code>
<div class="block">Return the block populator</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.bukkit.Location</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#getFixedSpawnLocation(org.bukkit.World,%20java.util.Random)">getFixedSpawnLocation</a></strong>(org.bukkit.World&nbsp;world,
java.util.Random&nbsp;random)</code>
<div class="block">Return the default spawn location for this world</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a
href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#getNewPlotWorld(java.lang.String)">getNewPlotWorld</a></strong>(java.lang.String&nbsp;world)</code>
<div class="block">Get a new plotworld class For square plots you can use the
DefaultPlotWorld class which comes with PlotSquared
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#getPlotManager()">getPlotManager</a></strong>()</code>
<div class="block">Return the plot manager for this type of generator, or create one For
square plots you may as well use the default plot manager which comes
with PlotSquared
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#nextLong()">nextLong</a></strong>()</code>&nbsp;
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#random(int)">random</a></strong>(int&nbsp;n)</code>&nbsp;
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#setCuboidRegion(int,%20int,%20int,%20int,%20int,%20int,%20com.intellectualcrafters.plot.object.PlotBlock)">setCuboidRegion</a></strong>(int&nbsp;x1,
int&nbsp;x2,
int&nbsp;y1,
int&nbsp;y2,
int&nbsp;z1,
int&nbsp;z2,
<a href="../../../../com/intellectualcrafters/plot/object/PlotBlock.html"
title="class in com.intellectualcrafters.plot.object">PlotBlock</a>&nbsp;block)</code>
<div class="block">Cuboid based plot generation is quick, as it requires no calculations
inside the loop - You don't have to use this this method, but you may
find it useful.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/generator/WorldGenerator.html#xorShift64(long)">xorShift64</a></strong>(long&nbsp;a)</code>&nbsp;
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a
name="methods_inherited_from_class_org.bukkit.generator.ChunkGenerator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.bukkit.generator.ChunkGenerator</h3>
<code>generate, generateBlockSections</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait,
wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WorldGenerator(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WorldGenerator</h4>
<pre>public&nbsp;WorldGenerator(java.lang.String&nbsp;world)</pre>
<div class="block">Initialize variables, and create plotworld object used in calculations
</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPlotManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotManager</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a>&nbsp;getPlotManager()</pre>
<div class="block">Return the plot manager for this type of generator, or create one For
square plots you may as well use the default plot manager which comes
with PlotSquared
</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html#getPlotManager()">getPlotManager</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html"
title="class in com.intellectualcrafters.plot.object">PlotGenerator</a></code>
</dd>
</dl>
</li>
</ul>
<a name="canSpawn(org.bukkit.World, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canSpawn</h4>
<pre>public&nbsp;boolean&nbsp;canSpawn(org.bukkit.World&nbsp;world,
int&nbsp;x,
int&nbsp;z)</pre>
<div class="block">Allow spawning everywhere</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>canSpawn</code>&nbsp;in
class&nbsp;<code>org.bukkit.generator.ChunkGenerator</code></dd>
</dl>
</li>
</ul>
<a name="getNewPlotWorld(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewPlotWorld</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a>&nbsp;getNewPlotWorld(java.lang.String&nbsp;world)</pre>
<div class="block">Get a new plotworld class For square plots you can use the
DefaultPlotWorld class which comes with PlotSquared
</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html#getNewPlotWorld(java.lang.String)">getNewPlotWorld</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../../com/intellectualcrafters/plot/object/PlotGenerator.html"
title="class in com.intellectualcrafters.plot.object">PlotGenerator</a></code>
</dd>
</dl>
</li>
</ul>
<a name="nextLong()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextLong</h4>
<pre>public final&nbsp;long&nbsp;nextLong()</pre>
</li>
</ul>
<a name="xorShift64(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>xorShift64</h4>
<pre>public final&nbsp;long&nbsp;xorShift64(long&nbsp;a)</pre>
</li>
</ul>
<a name="random(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>random</h4>
<pre>public final&nbsp;int&nbsp;random(int&nbsp;n)</pre>
</li>
</ul>
<a name="setCuboidRegion(int, int, int, int, int, int, com.intellectualcrafters.plot.object.PlotBlock)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCuboidRegion</h4>
<pre>public&nbsp;void&nbsp;setCuboidRegion(int&nbsp;x1,
int&nbsp;x2,
int&nbsp;y1,
int&nbsp;y2,
int&nbsp;z1,
int&nbsp;z2,
<a href="../../../../com/intellectualcrafters/plot/object/PlotBlock.html"
title="class in com.intellectualcrafters.plot.object">PlotBlock</a>&nbsp;block)</pre>
<div class="block">Cuboid based plot generation is quick, as it requires no calculations
inside the loop - You don't have to use this this method, but you may
find it useful.
</div>
</li>
</ul>
<a name="getDefaultPopulators(org.bukkit.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultPopulators</h4>
<pre>public&nbsp;java.util.List&lt;org.bukkit.generator.BlockPopulator&gt;&nbsp;getDefaultPopulators(org.bukkit.World&nbsp;world)</pre>
<div class="block">Return the block populator</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDefaultPopulators</code>&nbsp;in class&nbsp;<code>org.bukkit.generator.ChunkGenerator</code>
</dd>
</dl>
</li>
</ul>
<a name="getFixedSpawnLocation(org.bukkit.World, java.util.Random)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFixedSpawnLocation</h4>
<pre>public&nbsp;org.bukkit.Location&nbsp;getFixedSpawnLocation(org.bukkit.World&nbsp;world,
java.util.Random&nbsp;random)</pre>
<div class="block">Return the default spawn location for this world</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getFixedSpawnLocation</code>&nbsp;in class&nbsp;<code>org.bukkit.generator.ChunkGenerator</code>
</dd>
</dl>
</li>
</ul>
<a name="generateExtBlockSections(org.bukkit.World, java.util.Random, int, int, org.bukkit.generator.ChunkGenerator.BiomeGrid)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateExtBlockSections</h4>
<pre>public&nbsp;short[][]&nbsp;generateExtBlockSections(org.bukkit.World&nbsp;world,
java.util.Random&nbsp;random,
int&nbsp;cx,
int&nbsp;cz,
org.bukkit.generator.ChunkGenerator.BiomeGrid&nbsp;biomes)</pre>
<div class="block">This part is a fucking mess. - Refer to a proper tutorial if you would
like to learn how to make a world generator
</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>generateExtBlockSections</code>&nbsp;in class&nbsp;<code>org.bukkit.generator.ChunkGenerator</code>
</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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><a href="../../../../com/intellectualcrafters/plot/generator/DefaultPlotWorld.html"
title="class in com.intellectualcrafters.plot.generator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/generator/XPopulator.html"
title="class in com.intellectualcrafters.plot.generator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/generator/WorldGenerator.html" target="_top">Frames</a>
</li>
<li><a href="WorldGenerator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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><a href="#nested_classes_inherited_from_class_org.bukkit.generator.ChunkGenerator">Nested</a>&nbsp;|&nbsp;
</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>
Reference in New Issue Copy Permalink