AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-11-20 07:15:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
ecd192d468
Scissors-Website/javadoc/1.19.4/org/bukkit/generator/LimitedRegion.html

485 lines
42 KiB
HTML
Raw Normal View History

Test
2023-04-03 01:49:18 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>LimitedRegion (Scissors-API 1.19.4-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, interface: LimitedRegion">
<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.6.0.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="class-use/LimitedRegion.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.bukkit.generator</a></div>
<h1 title="Interface LimitedRegion" class="title">Interface LimitedRegion</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code>net.kyori.adventure.key.Keyed</code>, <code><a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></code>, <code><a href="../RegionAccessor.html" title="interface in org.bukkit">RegionAccessor</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">LimitedRegion</span><span class="extends-implements">
extends <a href="../RegionAccessor.html" title="interface in org.bukkit">RegionAccessor</a></span></div>
<div class="block">A limited region is used in world generation for features which are
going over a chunk. For example, trees or ores.
Use <a href="#getBuffer()"><code>getBuffer()</code></a> to know how much you can go beyond the central
chunk. The buffer zone may or may not be already populated.
The coordinates are <b>absolute</b> from the world origin.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default <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="../block/data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBlockData(org.bukkit.util.Vector)" class="member-name-link">getBlockData</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;vector)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a> of the block at the provided coordinates.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBlockState(org.bukkit.util.Vector)" class="member-name-link">getBlockState</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBuffer()" class="member-name-link">getBuffer</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the buffer around the central chunk which is accessible.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCenterBlockX()" class="member-name-link">getCenterBlockX</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the X-coordinate of the block in the center of the region.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getCenterBlockZ()" class="member-name-link">getCenterBlockZ</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Gets the Z-coordinate of the block in the center of the region.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCenterChunkX()" class="member-name-link">getCenterChunkX</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the X-coordinate of the chunk in the center of the region.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCenterChunkZ()" class="member-name-link">getCenterChunkZ</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the Z-coordinate of the chunk in the center of the region.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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>&lt;<a href="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTileEntities()" class="member-name-link">getTileEntities</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a list of all tile entities in the limited region including the
buffer zone.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="../World.html" title="interface in org.bukkit">World</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getWorld()" class="member-name-link">getWorld</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the <a href="../World.html" title="interface in org.bukkit"><code>World</code></a> object this region represents.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isInRegion(int,int,int)" class="member-name-link">isInRegion</a><wbr>(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if the given coordinates are in the region.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isInRegion(org.bukkit.Location)" class="member-name-link">isInRegion</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="../Location.html" title="class in org.bukkit">Location</a>&nbsp;location)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if the given <a href="../Location.html" title="class in org.bukkit"><code>Location</code></a> is in the region.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scheduleBlockUpdate(int,int,int)" class="member-name-link">scheduleBlockUpdate</a><wbr>(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Schedules a block update at (x, y, z).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#scheduleBlockUpdate(org.bukkit.util.Vector)" class="member-name-link">scheduleBlockUpdate</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Schedules a block update at a vector location.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scheduleFluidUpdate(int,int,int)" class="member-name-link">scheduleFluidUpdate</a><wbr>(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Schedules a fluid update at (x, y, z).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#scheduleFluidUpdate(org.bukkit.util.Vector)" class="member-name-link">scheduleFluidUpdate</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Schedules a fluid update at a vector location.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setBlockData(org.bukkit.util.Vector,org.bukkit.block.data.BlockData)" class="member-name-link">setBlockData</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;vector,
<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="../block/data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sets the block at a vector location to the provided <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setBlockState(int,int,int,org.bukkit.block.BlockState)" class="member-name-link">setBlockState</a><wbr>(int&nbsp;x,
int&nbsp;y,
int&nbsp;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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&nbsp;state)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setBlockState(org.bukkit.util.Vector,org.bukkit.block.BlockState)" class="member-name-link">setBlockState</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location,
<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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&nbsp;state)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.Keyed">Methods inherited from interface&nbsp;org.bukkit.<a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></h3>
<code><a href="../Keyed.html#key()">key</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.RegionAccessor">Methods inherited from interface&nbsp;org.bukkit.<a href="../RegionAccessor.html" title="interface in org.bukkit">RegionAccessor</a></h3>
<code><a href="../RegionAccessor.html#generateTree(org.bukkit.Location,java.util.Random,org.bukkit.TreeType)">generateTree</a>, <a href="../RegionAccessor.html#generateTree(org.bukkit.Location,java.util.Random,org.bukkit.TreeType,java.util.function.Predicate)">generateTree</a>, <a href="../RegionAccessor.html#generateTree(org.bukkit.Location,java.util.Random,org.bukkit.TreeType,org.bukkit.util.Consumer)">generateTree</a>, <a href="../RegionAccessor.html#getBiome(int,int,int)">getBiome</a>, <a href="../RegionAccessor.html#getBiome(org.bukkit.Location)">getBiome</a>, <a href="../RegionAccessor.html#getBlockData(int,int,int)">getBlockData</a>, <a href="../RegionAccessor.html#getBlockData(org.bukkit.Location)">getBlockData</a>, <a href="../RegionAccessor.html#getBlockState(int,int,int)">getBlockState</a>, <a href="../RegionAccessor.html#getBlockState(org.bukkit.Location)">getBlockState</a>, <a href="../RegionAccessor.html#getComputedBiome(int,int,int)">getComputedBiome</a>, <a href="../RegionAccessor.html#getEntities()">getEntities</a>, <a href="../RegionAccessor.html#getEntitiesByClass(java.lang.Class)">getEntitiesByClass</a>, <a href="../RegionAccessor.html#getEntitiesByClasses(java.lang.Class...)">getEntitiesByClasses</a>, <a href="../RegionAccessor.html#getKey()">getKey</a>, <a href="../RegionAccessor.html#getLivingEntities()">getLivingEntities</a>, <a href="../RegionAccessor.html#getMoonPhase()">getMoonPhase</a>, <a href="../RegionAccessor.html#getType(int,int,int)">getType</a>, <a href="../RegionAccessor.html#getType(org.bukkit.Location)">getType</a>, <a href="../RegionAccessor.html#hasCollisionsIn(org.bukkit.util.BoundingBox)">hasCollisionsIn</a>, <a href="../RegionAccessor.html#lineOfSightExists(org.bukkit.Location,org.bukkit.Location)">lineOfSightExists</a>, <a href="../RegionAccessor.html#setBiome(int,int,int,org.bukkit.block.Biome)">setBiome</a>, <a href="../RegionAccessor.html#setBiome(org.bukkit.Location,org.bukkit.block.Biome)">setBiome</a>, <a href="../RegionAccessor.html#setBlockData(int,int,int,org.bukkit.block.data.BlockData)">setBlockData</a>, <a href="../RegionAccessor.html#setBlockData(org.bukkit.Location,org.bukkit.block.data.BlockData)">setBlockData</a>, <a href="../RegionAccessor.html#setType(int,int,int,org.bukkit.Material)">setType</a>, <a href="../RegionAccessor.html#setType(org.bukkit.Location,org.bukkit.Material)">setType</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class)">spawn</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class,boolean,org.bukkit.util.Consumer)">spawn</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class,org.bukkit.util.Consumer)">spawn</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class,org.bukkit.util.Consumer,org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason)">spawn</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class,org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason)">spawn</a>, <a href="../RegionAccessor.html#spawn(org.bukkit.Location,java.lang.Class,org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason,org.bukkit.util.Consumer)">spawn</a>, <a href="../RegionAccessor.html#spawnEntity(org.bukkit.Location,org.bukkit.entity.EntityType)">spawnEntity</a>, <a href="../RegionAccessor.html#spawnEntity(org.bukkit.Location,org.bukkit.entity.EntityType,boolean)">spawnEntity</a>, <a href="../RegionAccessor.html#spawnEntity(org.bukkit.Location,org.bukkit.entity.EntityType,org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason)">spawnEntity</a>, <a href="../RegionAccessor.html#spawnEntity(org.bukkit.Location,org.bukkit.entity.EntityType,org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason,org.bukkit.util.Consumer)">spawnEntity</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getBuffer()">
<h3>getBuffer</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getBuffer</span>()</div>
<div class="block">Gets the buffer around the central chunk which is accessible.
The returned value is in normal world coordinate scale.
<p>
For example: If the method returns 16 you have a working area of 48x48.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The buffer in X and Z direction</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isInRegion(org.bukkit.Location)">
<h3>isInRegion</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isInRegion</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="../Location.html" title="class in org.bukkit">Location</a>&nbsp;location)</span></div>
<div class="block">Checks if the given <a href="../Location.html" title="class in org.bukkit"><code>Location</code></a> is in the region.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - the location to check</dd>
<dt>Returns:</dt>
<dd>true if the location is in the region, otherwise false.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isInRegion(int,int,int)">
<h3>isInRegion</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isInRegion</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</span></div>
<div class="block">Checks if the given coordinates are in the region.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X-coordinate to check</dd>
<dd><code>y</code> - Y-coordinate to check</dd>
<dd><code>z</code> - Z-coordinate to check</dd>
<dt>Returns:</dt>
<dd>true if the coordinates are in the region, otherwise false.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTileEntities()">
<h3>getTileEntities</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="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>&lt;<a href="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&gt;</span>&nbsp;<span class="element-name">getTileEntities</span>()</div>
<div class="block">Gets a list of all tile entities in the limited region including the
buffer zone.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a list of tile entities.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setBlockData(org.bukkit.util.Vector,org.bukkit.block.data.BlockData)">
<h3>setBlockData</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setBlockData</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;vector,
<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="../block/data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</span></div>
<div class="block">Sets the block at a vector location to the provided <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>vector</code> - <a href="../util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> representing the position of the block to set.</dd>
<dd><code>data</code> - <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a> to set the block at the provided coordinates to.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setBlockState(int,int,int,org.bukkit.block.BlockState)">
<h3>setBlockState</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setBlockState</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
int&nbsp;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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&nbsp;state)</span></div>
<div class="block">Sets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X coordinate.</dd>
<dd><code>y</code> - Y coordinate.</dd>
<dd><code>z</code> - Z coordinate.</dd>
<dd><code>state</code> - The block state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setBlockState(org.bukkit.util.Vector,org.bukkit.block.BlockState)">
<h3>setBlockState</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setBlockState</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location,
<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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a>&nbsp;state)</span></div>
<div class="block">Sets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - Location to set block state.</dd>
<dd><code>state</code> - The block state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBlockState(org.bukkit.util.Vector)">
<h3>getBlockState</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">default</span>&nbsp;<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="../block/BlockState.html" title="interface in org.bukkit.block">BlockState</a></span>&nbsp;<span class="element-name">getBlockState</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</span></div>
<div class="block">Gets the <a href="../block/BlockState.html" title="interface in org.bukkit.block"><code>BlockState</code></a> at a location.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - Location to get block state from.</dd>
<dt>Returns:</dt>
<dd>The block state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="scheduleBlockUpdate(int,int,int)">
<h3>scheduleBlockUpdate</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">scheduleBlockUpdate</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</span></div>
<div class="block">Schedules a block update at (x, y, z).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X coordinate</dd>
<dd><code>y</code> - Y coordinate</dd>
<dd><code>z</code> - Z coordinate</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="scheduleBlockUpdate(org.bukkit.util.Vector)">
<h3>scheduleBlockUpdate</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">scheduleBlockUpdate</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</span></div>
<div class="block">Schedules a block update at a vector location.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - <a href="../util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> representing the position of the block to update.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="scheduleFluidUpdate(int,int,int)">
<h3>scheduleFluidUpdate</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">scheduleFluidUpdate</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</span></div>
<div class="block">Schedules a fluid update at (x, y, z).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X coordinate</dd>
<dd><code>y</code> - Y coordinate</dd>
<dd><code>z</code> - Z coordinate</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="scheduleFluidUpdate(org.bukkit.util.Vector)">
<h3>scheduleFluidUpdate</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">scheduleFluidUpdate</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;location)</span></div>
<div class="block">Schedules a fluid update at a vector location.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - <a href="../util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> representing the position of the block to update.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWorld()">
<h3>getWorld</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="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="../World.html" title="interface in org.bukkit">World</a></span>&nbsp;<span class="element-name">getWorld</span>()</div>
<div class="block">Gets the <a href="../World.html" title="interface in org.bukkit"><code>World</code></a> object this region represents.
<p>
Do <b>not</b> attempt to read from/write to this world! Doing so during generation <b>will cause a deadlock!</b></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <a href="../World.html" title="interface in org.bukkit"><code>World</code></a> object that this region represents.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBlockData(org.bukkit.util.Vector)">
<h3>getBlockData</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">default</span>&nbsp;<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="../block/data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></span>&nbsp;<span class="element-name">getBlockData</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="../util/Vector.html" title="class in org.bukkit.util">Vector</a>&nbsp;vector)</span></div>
<div class="block">Gets the <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a> of the block at the provided coordinates.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>vector</code> - <a href="../util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> representing the position of the block to get.</dd>
<dt>Returns:</dt>
<dd><a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a> at the coordinates</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCenterChunkX()">
<h3>getCenterChunkX</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getCenterChunkX</span>()</div>
<div class="block">Gets the X-coordinate of the chunk in the center of the region.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The center chunk's X coordinate.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCenterBlockX()">
<h3>getCenterBlockX</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCenterBlockX</span>()</div>
<div class="block">Gets the X-coordinate of the block in the center of the region.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The center chunk's X coordinate.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCenterChunkZ()">
<h3>getCenterChunkZ</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getCenterChunkZ</span>()</div>
<div class="block">Gets the Z-coordinate of the chunk in the center of the region.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The center chunk's Z coordinate.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCenterBlockZ()">
<h3>getCenterBlockZ</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCenterBlockZ</span>()</div>
<div class="block">Gets the Z-coordinate of the block in the center of the region.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The center chunk's Z coordinate.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink