mirror of https://github.com/Minestom/Minestom.git
552 lines
43 KiB
HTML
552 lines
43 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) -->
|
|
<title>BoundingBox (minestom dev 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: net.minestom.server.collision, class: BoundingBox">
|
|
<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">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
|
<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>
|
|
<ul class="sub-nav-list-small">
|
|
<li>
|
|
<p>Summary:</p>
|
|
<ul>
|
|
<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>
|
|
</li>
|
|
<li>
|
|
<p>Detail:</p>
|
|
<ul>
|
|
<li>Field</li>
|
|
<li><a href="#constructor-detail">Constr</a></li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list">
|
|
<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"><a href="../../../../search.html">SEARCH</a>
|
|
<input type="text" id="search-input" disabled placeholder="Search">
|
|
<input type="reset" id="reset-button" disabled value="reset">
|
|
</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">net.minestom.server.collision</a></div>
|
|
<h1 title="Class BoundingBox" class="title">Class BoundingBox</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/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">net.minestom.server.collision.BoundingBox</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundingBox</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
|
implements <a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></span></div>
|
|
<div class="block">See https://wiki.vg/Entity_metadata#Mobs_2</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 enum </code></div>
|
|
<div class="col-second even-row-color"><code><a href="BoundingBox.AxisMask.html" class="type-name-link" title="enum class in net.minestom.server.collision">BoundingBox.AxisMask</a></code></div>
|
|
<div class="col-last even-row-color"> </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(double,double,double)" class="member-name-link">BoundingBox</a><wbr>(double width,
|
|
double height,
|
|
double depth)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double,double,net.minestom.server.coordinate.Point)" class="member-name-link">BoundingBox</a><wbr>(double width,
|
|
double height,
|
|
double depth,
|
|
<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> offset)</code></div>
|
|
<div class="col-last odd-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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
|
|
<div class="summary-table three-column-summary">
|
|
<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="#boundingBoxRayIntersectionCheck(net.minestom.server.coordinate.Vec,net.minestom.server.coordinate.Vec,net.minestom.server.coordinate.Pos)" class="member-name-link">boundingBoxRayIntersectionCheck</a><wbr>(<a href="../coordinate/Vec.html" title="class in net.minestom.server.coordinate">Vec</a> start,
|
|
<a href="../coordinate/Vec.html" title="class in net.minestom.server.coordinate">Vec</a> direction,
|
|
<a href="../coordinate/Pos.html" title="class in net.minestom.server.coordinate">Pos</a> position)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contract(double,double,double)" class="member-name-link">contract</a><wbr>(double x,
|
|
double y,
|
|
double z)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with a contracted size.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#depth()" class="member-name-link">depth</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expand(double,double,double)" class="member-name-link">expand</a><wbr>(double x,
|
|
double y,
|
|
double z)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with an expanded size.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromPose(net.minestom.server.entity.Entity.Pose)" class="member-name-link">fromPose</a><wbr>(<a href="../entity/Entity.Pose.html" title="enum class in net.minestom.server.entity">Entity.Pose</a> pose)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><wbr><<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlocks(net.minestom.server.coordinate.Point)" class="member-name-link">getBlocks</a><wbr>(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> point)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><wbr><<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlocks(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox.AxisMask,double)" class="member-name-link">getBlocks</a><wbr>(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> point,
|
|
<a href="BoundingBox.AxisMask.html" title="enum class in net.minestom.server.collision">BoundingBox.AxisMask</a> axisMask,
|
|
double axis)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#height()" class="member-name-link">height</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#intersectBox(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox)" class="member-name-link">intersectBox</a><wbr>(@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> positionRelative,
|
|
@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a> boundingBox)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if two bounding boxes intersect.</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="#intersectBoxSwept(net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox,net.minestom.server.collision.SweepResult)" class="member-name-link">intersectBoxSwept</a><wbr>(@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> rayStart,
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> rayDirection,
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> shapePos,
|
|
@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a> moving,
|
|
@NotNull <a href="SweepResult.html" title="class in net.minestom.server.collision">SweepResult</a> finalResult)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if a moving bounding box will hit this shape.</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="#isOccluded(net.minestom.server.collision.Shape,net.minestom.server.instance.block.BlockFace)" class="member-name-link">isOccluded</a><wbr>(@NotNull <a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a> shape,
|
|
@NotNull <a href="../instance/block/BlockFace.html" title="enum class in net.minestom.server.instance.block">BlockFace</a> face)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxX()" class="member-name-link">maxX</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxY()" class="member-name-link">maxY</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxZ()" class="member-name-link">maxZ</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#minX()" class="member-name-link">minX</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#minY()" class="member-name-link">minY</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#minZ()" class="member-name-link">minZ</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#relativeEnd()" class="member-name-link">relativeEnd</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Relative End</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#relativeStart()" class="member-name-link">relativeStart</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Relative Start</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#width()" class="member-name-link">width</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withOffset(net.minestom.server.coordinate.Point)" class="member-name-link">withOffset</a><wbr>(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> offset)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with an offset.</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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-net.minestom.server.collision.Shape">Methods inherited from interface net.minestom.server.collision.<a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></h3>
|
|
<code><a href="Shape.html#intersectEntity(net.minestom.server.coordinate.Point,net.minestom.server.entity.Entity)">intersectEntity</a>, <a href="Shape.html#isFaceFull(net.minestom.server.instance.block.BlockFace)">isFaceFull</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>(double,double,double,net.minestom.server.coordinate.Point)">
|
|
<h3>BoundingBox</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BoundingBox</span><wbr><span class="parameters">(double width,
|
|
double height,
|
|
double depth,
|
|
<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> offset)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(double,double,double)">
|
|
<h3>BoundingBox</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BoundingBox</span><wbr><span class="parameters">(double width,
|
|
double height,
|
|
double depth)</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="isOccluded(net.minestom.server.collision.Shape,net.minestom.server.instance.block.BlockFace)">
|
|
<h3>isOccluded</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOccluded</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a> shape,
|
|
@NotNull
|
|
@NotNull <a href="../instance/block/BlockFace.html" title="enum class in net.minestom.server.instance.block">BlockFace</a> face)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="Shape.html#isOccluded(net.minestom.server.collision.Shape,net.minestom.server.instance.block.BlockFace)">isOccluded</a></code> in interface <code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="intersectBox(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox)">
|
|
<h3>intersectBox</h3>
|
|
<div class="member-signature"><span class="annotations">@Experimental
|
|
</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">intersectBox</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> positionRelative,
|
|
@NotNull
|
|
@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a> boundingBox)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="Shape.html#intersectBox(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox)">Shape</a></code></span></div>
|
|
<div class="block">Checks if two bounding boxes intersect.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="Shape.html#intersectBox(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox)">intersectBox</a></code> in interface <code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>positionRelative</code> - Relative position of bounding box to check with</dd>
|
|
<dd><code>boundingBox</code> - Bounding box to check for intersections with</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>is an intersection found</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="intersectBoxSwept(net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox,net.minestom.server.collision.SweepResult)">
|
|
<h3>intersectBoxSwept</h3>
|
|
<div class="member-signature"><span class="annotations">@Experimental
|
|
</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">intersectBoxSwept</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> rayStart,
|
|
@NotNull
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> rayDirection,
|
|
@NotNull
|
|
@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> shapePos,
|
|
@NotNull
|
|
@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a> moving,
|
|
@NotNull
|
|
@NotNull <a href="SweepResult.html" title="class in net.minestom.server.collision">SweepResult</a> finalResult)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="Shape.html#intersectBoxSwept(net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox,net.minestom.server.collision.SweepResult)">Shape</a></code></span></div>
|
|
<div class="block">Checks if a moving bounding box will hit this shape.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="Shape.html#intersectBoxSwept(net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox,net.minestom.server.collision.SweepResult)">intersectBoxSwept</a></code> in interface <code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>rayStart</code> - Position of the moving shape</dd>
|
|
<dd><code>rayDirection</code> - Movement vector</dd>
|
|
<dd><code>shapePos</code> - Position of this shape</dd>
|
|
<dd><code>moving</code> - Bounding Box of moving shape</dd>
|
|
<dd><code>finalResult</code> - Stores final SweepResult</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>is an intersection found</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="boundingBoxRayIntersectionCheck(net.minestom.server.coordinate.Vec,net.minestom.server.coordinate.Vec,net.minestom.server.coordinate.Pos)">
|
|
<h3>boundingBoxRayIntersectionCheck</h3>
|
|
<div class="member-signature"><span class="annotations">@Experimental
|
|
</span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">boundingBoxRayIntersectionCheck</span><wbr><span class="parameters">(<a href="../coordinate/Vec.html" title="class in net.minestom.server.coordinate">Vec</a> start,
|
|
<a href="../coordinate/Vec.html" title="class in net.minestom.server.coordinate">Vec</a> direction,
|
|
<a href="../coordinate/Pos.html" title="class in net.minestom.server.coordinate">Pos</a> position)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="relativeStart()">
|
|
<h3>relativeStart</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a></span> <span class="element-name">relativeStart</span>()</div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="Shape.html#relativeStart()">Shape</a></code></span></div>
|
|
<div class="block">Relative Start</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="Shape.html#relativeStart()">relativeStart</a></code> in interface <code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Start of shape</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="relativeEnd()">
|
|
<h3>relativeEnd</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a></span> <span class="element-name">relativeEnd</span>()</div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="Shape.html#relativeEnd()">Shape</a></code></span></div>
|
|
<div class="block">Relative End</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="Shape.html#relativeEnd()">relativeEnd</a></code> in interface <code><a href="Shape.html" title="interface in net.minestom.server.collision">Shape</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>End of shape</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toString()">
|
|
<h3>toString</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="expand(double,double,double)">
|
|
<h3>expand</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></span> <span class="element-name">expand</span><wbr><span class="parameters">(double x,
|
|
double y,
|
|
double z)</span></div>
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with an expanded size.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>x</code> - the X offset</dd>
|
|
<dd><code>y</code> - the Y offset</dd>
|
|
<dd><code>z</code> - the Z offset</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> expanded</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="contract(double,double,double)">
|
|
<h3>contract</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></span> <span class="element-name">contract</span><wbr><span class="parameters">(double x,
|
|
double y,
|
|
double z)</span></div>
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with a contracted size.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>x</code> - the X offset</dd>
|
|
<dd><code>y</code> - the Y offset</dd>
|
|
<dd><code>z</code> - the Z offset</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new bounding box contracted</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="withOffset(net.minestom.server.coordinate.Point)">
|
|
<h3>withOffset</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></span> <span class="element-name">withOffset</span><wbr><span class="parameters">(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> offset)</span></div>
|
|
<div class="block">Creates a new <a href="BoundingBox.html" title="class in net.minestom.server.collision"><code>BoundingBox</code></a> with an offset.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>offset</code> - the offset</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new bounding box with an offset.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="width()">
|
|
<h3>width</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">width</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="height()">
|
|
<h3>height</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">height</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="depth()">
|
|
<h3>depth</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">depth</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="minX()">
|
|
<h3>minX</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">minX</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="maxX()">
|
|
<h3>maxX</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">maxX</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="minY()">
|
|
<h3>minY</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">minY</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="maxY()">
|
|
<h3>maxY</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">maxY</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="minZ()">
|
|
<h3>minZ</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">minZ</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="maxZ()">
|
|
<h3>maxZ</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">maxZ</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlocks(net.minestom.server.coordinate.Point)">
|
|
<h3>getBlocks</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a>></span> <span class="element-name">getBlocks</span><wbr><span class="parameters">(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> point)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlocks(net.minestom.server.coordinate.Point,net.minestom.server.collision.BoundingBox.AxisMask,double)">
|
|
<h3>getBlocks</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a>></span> <span class="element-name">getBlocks</span><wbr><span class="parameters">(<a href="../coordinate/Point.html" title="interface in net.minestom.server.coordinate">Point</a> point,
|
|
<a href="BoundingBox.AxisMask.html" title="enum class in net.minestom.server.collision">BoundingBox.AxisMask</a> axisMask,
|
|
double axis)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="equals(java.lang.Object)">
|
|
<h3>equals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="fromPose(net.minestom.server.entity.Entity.Pose)">
|
|
<h3>fromPose</h3>
|
|
<div class="member-signature"><span class="annotations">@Nullable
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@Nullable <a href="BoundingBox.html" title="class in net.minestom.server.collision">BoundingBox</a></span> <span class="element-name">fromPose</span><wbr><span class="parameters">(@NotNull
|
|
<a href="../entity/Entity.Pose.html" title="enum class in net.minestom.server.entity">Entity.Pose</a> pose)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|