mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-09-18 21:28:15 +00:00
810 lines
73 KiB
HTML
810 lines
73 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ChunkGenerator (Scissors-API 1.18.2-R0.1-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="description" content="declaration: package: org.bukkit.generator, class: ChunkGenerator">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.bukkit.generator</a></div>
|
|
<h1 title="Class ChunkGenerator" class="title">Class ChunkGenerator</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">org.bukkit.generator.ChunkGenerator</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ChunkGenerator</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">A chunk generator is responsible for the initial shaping of an entire
|
|
chunk. For example, the nether chunk generator should shape netherrack and
|
|
soulsand.
|
|
|
|
A chunk is generated in multiple steps, those steps are always in the same
|
|
order. Between those steps however an unlimited time may pass. This means, a
|
|
chunk may generated until the surface step and continue with the bedrock step
|
|
after one or multiple server restarts or even after multiple Minecraft
|
|
versions.
|
|
|
|
The order of generation is as follows
|
|
<ol>
|
|
<li><a href="#generateNoise(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateNoise(WorldInfo, Random, int, int, ChunkData)</code></a></li>
|
|
<li><a href="#generateSurface(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateSurface(WorldInfo, Random, int, int, ChunkData)</code></a></li>
|
|
<li><a href="#generateBedrock(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateBedrock(WorldInfo, Random, int, int, ChunkData)</code></a></li>
|
|
<li><a href="#generateCaves(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateCaves(WorldInfo, Random, int, int, ChunkData)</code></a></li>
|
|
</ol>
|
|
|
|
Every method listed above as well as
|
|
<a href="#getBaseHeight(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.HeightMap)"><code>getBaseHeight(WorldInfo, Random, int, int, HeightMap)</code></a>
|
|
<b>must</b> be completely thread safe and able to handle multiple concurrent
|
|
callers.
|
|
|
|
Some aspects of world generation can be delegated to the Vanilla generator.
|
|
The following methods can be overridden to enable this:
|
|
<ul>
|
|
<li><a href="#shouldGenerateNoise()"><code>shouldGenerateNoise()</code></a></li>
|
|
<li><a href="#shouldGenerateSurface()"><code>shouldGenerateSurface()</code></a></li>
|
|
<li><a href="#shouldGenerateBedrock()"><code>shouldGenerateBedrock()</code></a></li>
|
|
<li><a href="#shouldGenerateCaves()"><code>shouldGenerateCaves()</code></a></li>
|
|
<li><a href="#shouldGenerateDecorations()"><code>shouldGenerateDecorations()</code></a></li>
|
|
<li><a href="#shouldGenerateMobs()"><code>shouldGenerateMobs()</code></a></li>
|
|
<li><a href="#shouldGenerateStructures()"><code>shouldGenerateStructures()</code></a></li>
|
|
</ul></div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="caption"><span>Nested Classes</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static interface </code></div>
|
|
<div class="col-second even-row-color"><code><a href="ChunkGenerator.BiomeGrid.html" class="type-name-link" title="interface in org.bukkit.generator">ChunkGenerator.BiomeGrid</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Biomes are now set with <a href="BiomeProvider.html" title="class in org.bukkit.generator"><code>BiomeProvider</code></a></div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static interface </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="ChunkGenerator.ChunkData.html" class="type-name-link" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Data for a Chunk.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ChunkGenerator</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canSpawn(org.bukkit.World,int,int)" class="member-name-link">canSpawn</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
int x,
|
|
int z)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Tests if the specified location is valid for a natural spawn position</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>protected final <a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createChunkData(org.bukkit.World)" class="member-name-link">createChunkData</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment"><a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> are now directly provided</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createVanillaChunkData(org.bukkit.World,int,int)" class="member-name-link">createVanillaChunkData</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
int x,
|
|
int z)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Create a ChunkData for use in a generator, that is populated by the vanilla generator for that world</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateBedrock(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)" class="member-name-link">generateBedrock</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Shapes the Chunk bedrock layer for the given coordinates.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateCaves(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)" class="member-name-link">generateCaves</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Shapes the Chunk caves for the given coordinates.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#generateChunkData(org.bukkit.World,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.BiomeGrid)" class="member-name-link">generateChunkData</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int x,
|
|
int z,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.BiomeGrid.html" title="interface in org.bukkit.generator">ChunkGenerator.BiomeGrid</a> biome)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">The generation is now split up and the new methods should be used, see <a href="ChunkGenerator.html" title="class in org.bukkit.generator"><code>ChunkGenerator</code></a></div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateNoise(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)" class="member-name-link">generateNoise</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Shapes the Chunk noise for the given coordinates.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateSurface(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)" class="member-name-link">generateSurface</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Shapes the Chunk surface for the given coordinates.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBaseHeight(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.HeightMap)" class="member-name-link">getBaseHeight</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int x,
|
|
int z,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../HeightMap.html" title="enum class in org.bukkit">HeightMap</a> heightMap)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">This method is similar to
|
|
<a href="../World.html#getHighestBlockAt(int,int,org.bukkit.HeightMap)"><code>World.getHighestBlockAt(int, int, HeightMap)</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="BiomeProvider.html" title="class in org.bukkit.generator">BiomeProvider</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultBiomeProvider(org.bukkit.generator.WorldInfo)" class="member-name-link">getDefaultBiomeProvider</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets called when no <a href="BiomeProvider.html" title="class in org.bukkit.generator"><code>BiomeProvider</code></a> is set in
|
|
<a href="../WorldCreator.html" title="class in org.bukkit"><code>WorldCreator</code></a> or via the server configuration files.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="BlockPopulator.html" title="class in org.bukkit.generator">BlockPopulator</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultPopulators(org.bukkit.World)" class="member-name-link">getDefaultPopulators</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets a list of default <a href="BlockPopulator.html" title="class in org.bukkit.generator"><code>BlockPopulator</code></a>s to apply to a given
|
|
world</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Location.html" title="class in org.bukkit">Location</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFixedSpawnLocation(org.bukkit.World,java.util.Random)" class="member-name-link">getFixedSpawnLocation</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets a fixed spawn location to use for a given world.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isParallelCapable()" class="member-name-link">isParallelCapable</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">the chunk generation code should be thread safe</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateBedrock()" class="member-name-link">shouldGenerateBedrock</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla bedrock.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateCaves()" class="member-name-link">shouldGenerateCaves</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla caves.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateDecorations()" class="member-name-link">shouldGenerateDecorations</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla decorations after this
|
|
ChunkGenerator.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateMobs()" class="member-name-link">shouldGenerateMobs</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla mobs after this
|
|
ChunkGenerator.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateNoise()" class="member-name-link">shouldGenerateNoise</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla noise.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateStructures()" class="member-name-link">shouldGenerateStructures</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla structures after this
|
|
ChunkGenerator.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldGenerateSurface()" class="member-name-link">shouldGenerateSurface</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if the server should generate Vanilla surface.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>ChunkGenerator</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ChunkGenerator</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="generateNoise(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)">
|
|
<h3>generateNoise</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generateNoise</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</span></div>
|
|
<div class="block">Shapes the Chunk noise for the given coordinates.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at the passed
|
|
coordinates, as doing so may cause an infinite loop.
|
|
<p>
|
|
This method should <b>never</b> modify the <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> at a later
|
|
point of time.
|
|
<p>
|
|
The Y-coordinate range should <b>never</b> be hardcoded, to get the
|
|
Y-coordinate range use the methods <a href="ChunkGenerator.ChunkData.html#getMinHeight()"><code>ChunkGenerator.ChunkData.getMinHeight()</code></a> and
|
|
<a href="ChunkGenerator.ChunkData.html#getMaxHeight()"><code>ChunkGenerator.ChunkData.getMaxHeight()</code></a>.
|
|
<p>
|
|
If <a href="#shouldGenerateNoise()"><code>shouldGenerateNoise()</code></a> is set to true, the given
|
|
<a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> contains already the Vanilla noise generation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>chunkX</code> - The X-coordinate of the chunk</dd>
|
|
<dd><code>chunkZ</code> - The Z-coordinate of the chunk</dd>
|
|
<dd><code>chunkData</code> - To modify</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="generateSurface(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)">
|
|
<h3>generateSurface</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generateSurface</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</span></div>
|
|
<div class="block">Shapes the Chunk surface for the given coordinates.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at the passed
|
|
coordinates, as doing so may cause an infinite loop.
|
|
<p>
|
|
This method should <b>never</b> modify the <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> at a later
|
|
point of time.
|
|
<p>
|
|
The Y-coordinate range should <b>never</b> be hardcoded, to get the
|
|
Y-coordinate range use the methods <a href="ChunkGenerator.ChunkData.html#getMinHeight()"><code>ChunkGenerator.ChunkData.getMinHeight()</code></a> and
|
|
<a href="ChunkGenerator.ChunkData.html#getMaxHeight()"><code>ChunkGenerator.ChunkData.getMaxHeight()</code></a>.
|
|
<p>
|
|
If <a href="#shouldGenerateSurface()"><code>shouldGenerateSurface()</code></a> is set to true, the given
|
|
<a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> contains already the Vanilla surface generation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>chunkX</code> - The X-coordinate of the chunk</dd>
|
|
<dd><code>chunkZ</code> - The Z-coordinate of the chunk</dd>
|
|
<dd><code>chunkData</code> - To modify</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="generateBedrock(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)">
|
|
<h3>generateBedrock</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generateBedrock</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</span></div>
|
|
<div class="block">Shapes the Chunk bedrock layer for the given coordinates.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at the passed
|
|
coordinates, as doing so may cause an infinite loop.
|
|
<p>
|
|
This method should <b>never</b> modify the <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> at a later
|
|
point of time.
|
|
<p>
|
|
The Y-coordinate range should <b>never</b> be hardcoded, to get the
|
|
Y-coordinate range use the methods <a href="ChunkGenerator.ChunkData.html#getMinHeight()"><code>ChunkGenerator.ChunkData.getMinHeight()</code></a> and
|
|
<a href="ChunkGenerator.ChunkData.html#getMaxHeight()"><code>ChunkGenerator.ChunkData.getMaxHeight()</code></a>.
|
|
<p>
|
|
If <a href="#shouldGenerateBedrock()"><code>shouldGenerateBedrock()</code></a> is set to true, the given
|
|
<a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> contains already the Vanilla bedrock generation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>chunkX</code> - The X-coordinate of the chunk</dd>
|
|
<dd><code>chunkZ</code> - The Z-coordinate of the chunk</dd>
|
|
<dd><code>chunkData</code> - To modify</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="generateCaves(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)">
|
|
<h3>generateCaves</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generateCaves</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int chunkX,
|
|
int chunkZ,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a> chunkData)</span></div>
|
|
<div class="block">Shapes the Chunk caves for the given coordinates.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at the passed
|
|
coordinates, as doing so may cause an infinite loop.
|
|
<p>
|
|
This method should <b>never</b> modify the <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> at a later
|
|
point of time.
|
|
<p>
|
|
The Y-coordinate range should <b>never</b> be hardcoded, to get the
|
|
Y-coordinate range use the methods <a href="ChunkGenerator.ChunkData.html#getMinHeight()"><code>ChunkGenerator.ChunkData.getMinHeight()</code></a> and
|
|
<a href="ChunkGenerator.ChunkData.html#getMaxHeight()"><code>ChunkGenerator.ChunkData.getMaxHeight()</code></a>.
|
|
<p>
|
|
If <a href="#shouldGenerateCaves()"><code>shouldGenerateCaves()</code></a> is set to true, the given
|
|
<a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> contains already the Vanilla cave generation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>chunkX</code> - The X-coordinate of the chunk</dd>
|
|
<dd><code>chunkZ</code> - The Z-coordinate of the chunk</dd>
|
|
<dd><code>chunkData</code> - To modify</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDefaultBiomeProvider(org.bukkit.generator.WorldInfo)">
|
|
<h3>getDefaultBiomeProvider</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="BiomeProvider.html" title="class in org.bukkit.generator">BiomeProvider</a></span> <span class="element-name">getDefaultBiomeProvider</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo)</span></div>
|
|
<div class="block">Gets called when no <a href="BiomeProvider.html" title="class in org.bukkit.generator"><code>BiomeProvider</code></a> is set in
|
|
<a href="../WorldCreator.html" title="class in org.bukkit"><code>WorldCreator</code></a> or via the server configuration files. It
|
|
is therefore possible that one plugin can provide the Biomes and another
|
|
one the generation.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
If <code>null</code> is returned, than Vanilla biomes are used.
|
|
<p>
|
|
This method only gets called once when the world is loaded. Returning
|
|
another <a href="BiomeProvider.html" title="class in org.bukkit.generator"><code>BiomeProvider</code></a> later one is not respected.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world the biome provider will be
|
|
used for</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>BiomeProvider to use to fill the biomes of a chunk</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBaseHeight(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.HeightMap)">
|
|
<h3>getBaseHeight</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBaseHeight</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="WorldInfo.html" title="interface in org.bukkit.generator">WorldInfo</a> worldInfo,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int x,
|
|
int z,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../HeightMap.html" title="enum class in org.bukkit">HeightMap</a> heightMap)</span></div>
|
|
<div class="block">This method is similar to
|
|
<a href="../World.html#getHighestBlockAt(int,int,org.bukkit.HeightMap)"><code>World.getHighestBlockAt(int, int, HeightMap)</code></a>. With the difference
|
|
being, that the highest y coordinate should be the block before any
|
|
surface, bedrock, caves or decoration is applied. Or in other words the
|
|
highest block when only the noise is present at the chunk.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
When this method is not overridden, the Vanilla base height is used.
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at the passed
|
|
coordinates, or use the method
|
|
<a href="../World.html#getHighestBlockAt(int,int,org.bukkit.HeightMap)"><code>World.getHighestBlockAt(int, int, HeightMap)</code></a>, as doing so may
|
|
cause an infinite loop.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>worldInfo</code> - The world info of the world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>x</code> - The X-coordinate from world origin</dd>
|
|
<dd><code>z</code> - The Z-coordinate from world origin</dd>
|
|
<dd><code>heightMap</code> - From the highest block should be get</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The y coordinate of the highest block at the given location</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="generateChunkData(org.bukkit.World,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.BiomeGrid)">
|
|
<h3>generateChunkData</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></span> <span class="element-name">generateChunkData</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random,
|
|
int x,
|
|
int z,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.BiomeGrid.html" title="interface in org.bukkit.generator">ChunkGenerator.BiomeGrid</a> biome)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">The generation is now split up and the new methods should be used, see <a href="ChunkGenerator.html" title="class in org.bukkit.generator"><code>ChunkGenerator</code></a></div>
|
|
</div>
|
|
<div class="block">Shapes the chunk for the given coordinates.
|
|
|
|
This method must return a ChunkData.
|
|
<p>
|
|
Notes:
|
|
<p>
|
|
This method should <b>never</b> attempt to get the Chunk at
|
|
the passed coordinates, as doing so may cause an infinite loop
|
|
<p>
|
|
This method should <b>never</b> modify a ChunkData after it has
|
|
been returned.
|
|
<p>
|
|
This method <b>must</b> return a ChunkData returned by <a href="#createChunkData(org.bukkit.World)"><code>createChunkData(org.bukkit.World)</code></a></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - The world this chunk will be used for</dd>
|
|
<dd><code>random</code> - The random generator to use</dd>
|
|
<dd><code>x</code> - The X-coordinate of the chunk</dd>
|
|
<dd><code>z</code> - The Z-coordinate of the chunk</dd>
|
|
<dd><code>biome</code> - Proposed biome values for chunk - can be updated by
|
|
generator</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>ChunkData containing the types for each block created by this
|
|
generator</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createChunkData(org.bukkit.World)">
|
|
<h3>createChunkData</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">protected final</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></span> <span class="element-name">createChunkData</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment"><a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator"><code>ChunkGenerator.ChunkData</code></a> are now directly provided</div>
|
|
</div>
|
|
<div class="block">Create a ChunkData for a world.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - the world the ChunkData is for</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new ChunkData for world</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canSpawn(org.bukkit.World,int,int)">
|
|
<h3>canSpawn</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canSpawn</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
int x,
|
|
int z)</span></div>
|
|
<div class="block">Tests if the specified location is valid for a natural spawn position</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - The world we're testing on</dd>
|
|
<dd><code>x</code> - X-coordinate of the block to test</dd>
|
|
<dd><code>z</code> - Z-coordinate of the block to test</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the location is valid, otherwise false</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDefaultPopulators(org.bukkit.World)">
|
|
<h3>getDefaultPopulators</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="BlockPopulator.html" title="class in org.bukkit.generator">BlockPopulator</a>></span> <span class="element-name">getDefaultPopulators</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world)</span></div>
|
|
<div class="block">Gets a list of default <a href="BlockPopulator.html" title="class in org.bukkit.generator"><code>BlockPopulator</code></a>s to apply to a given
|
|
world</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - World to apply to</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>List containing any amount of BlockPopulators</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFixedSpawnLocation(org.bukkit.World,java.util.Random)">
|
|
<h3>getFixedSpawnLocation</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">getFixedSpawnLocation</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</span></div>
|
|
<div class="block">Gets a fixed spawn location to use for a given world.
|
|
<p>
|
|
A null value is returned if a world should not use a fixed spawn point,
|
|
and will instead attempt to find one randomly.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - The world to locate a spawn point for</dd>
|
|
<dd><code>random</code> - Random generator to use in the calculation</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Location containing a new spawn point, otherwise null</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isParallelCapable()">
|
|
<h3>isParallelCapable</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isParallelCapable</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">the chunk generation code should be thread safe</div>
|
|
</div>
|
|
<div class="block">Gets if this ChunkGenerator is parallel capable.
|
|
|
|
See <a href="ChunkGenerator.html" title="class in org.bukkit.generator"><code>ChunkGenerator</code></a> for more information.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>parallel capable status</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateNoise()">
|
|
<h3>shouldGenerateNoise</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateNoise</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla noise.
|
|
<p>
|
|
The Vanilla noise is generated <b>before</b>
|
|
<a href="#generateNoise(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateNoise(WorldInfo, Random, int, int, ChunkData)</code></a> is called.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla noise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateSurface()">
|
|
<h3>shouldGenerateSurface</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateSurface</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla surface.
|
|
<p>
|
|
The Vanilla surface is generated <b>before</b>
|
|
<a href="#generateSurface(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateSurface(WorldInfo, Random, int, int, ChunkData)</code></a> is
|
|
called.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla surface</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateBedrock()">
|
|
<h3>shouldGenerateBedrock</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateBedrock</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla bedrock.
|
|
<p>
|
|
The Vanilla bedrock is generated <b>before</b>
|
|
<a href="#generateBedrock(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateBedrock(WorldInfo, Random, int, int, ChunkData)</code></a> is
|
|
called.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla bedrock</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateCaves()">
|
|
<h3>shouldGenerateCaves</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateCaves</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla caves.
|
|
<p>
|
|
The Vanilla caves are generated <b>before</b>
|
|
<a href="#generateCaves(org.bukkit.generator.WorldInfo,java.util.Random,int,int,org.bukkit.generator.ChunkGenerator.ChunkData)"><code>generateCaves(WorldInfo, Random, int, int, ChunkData)</code></a> is called.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla caves</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateDecorations()">
|
|
<h3>shouldGenerateDecorations</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateDecorations</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla decorations after this
|
|
ChunkGenerator.
|
|
<p>
|
|
The Vanilla decoration are generated <b>before</b> any
|
|
<a href="BlockPopulator.html" title="class in org.bukkit.generator"><code>BlockPopulator</code></a> are called.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla decorations</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateMobs()">
|
|
<h3>shouldGenerateMobs</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateMobs</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla mobs after this
|
|
ChunkGenerator.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla mobs</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldGenerateStructures()">
|
|
<h3>shouldGenerateStructures</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldGenerateStructures</span>()</div>
|
|
<div class="block">Gets if the server should generate Vanilla structures after this
|
|
ChunkGenerator.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the server should generate Vanilla structures</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createVanillaChunkData(org.bukkit.World,int,int)">
|
|
<h3>createVanillaChunkData</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ChunkGenerator.ChunkData.html" title="interface in org.bukkit.generator">ChunkGenerator.ChunkData</a></span> <span class="element-name">createVanillaChunkData</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a> world,
|
|
int x,
|
|
int z)</span></div>
|
|
<div class="block">Create a ChunkData for use in a generator, that is populated by the vanilla generator for that world</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>world</code> - the world to create the ChunkData for</dd>
|
|
<dd><code>x</code> - the x coordinate of the chunk</dd>
|
|
<dd><code>z</code> - the z coordinate of the chunk</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new ChunkData for the world</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|