mirror of
https://github.com/Minestom/Minestom.git
synced 2025-01-25 01:21:20 +01:00
404 lines
16 KiB
HTML
404 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>RelativeLocation (Minestom 1.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: net.minestom.server.utils.location, class: RelativeLocation">
|
|
<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.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":6,"i1":10,"i2":10,"i3":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flexBox">
|
|
<header role="banner" class="flexHeader">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="skipNav"><a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
</nav>
|
|
</header>
|
|
<div class="flexContent">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.minestom.server.utils.location</a></div>
|
|
<h1 title="Class RelativeLocation" class="title">Class RelativeLocation<T></h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">net.minestom.server.utils.location.RelativeLocation<T></div>
|
|
</div>
|
|
<section class="description">
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>T</code> - the location type</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="RelativeBlockPosition.html" title="class in net.minestom.server.utils.location">RelativeBlockPosition</a></code>, <code><a href="RelativeVec.html" title="class in net.minestom.server.utils.location">RelativeVec</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public abstract class <span class="typeNameLabel">RelativeLocation<T></span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Represents a location which can have fields relative to an <a href="../../entity/Entity.html" title="class in net.minestom.server.entity"><code>Entity</code></a> position.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="fieldSummary"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Field Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Field</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected <a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#location">location</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relativeX">relativeX</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relativeY">relativeY</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relativeZ">relativeZ</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorSummary"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(T,boolean,boolean,boolean)">RelativeLocation</a></span>​(<a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a> location,
|
|
boolean relativeX,
|
|
boolean relativeY,
|
|
boolean relativeZ)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code>abstract <a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromRelativePosition(net.minestom.server.entity.Entity)">fromRelativePosition</a></span>​(<a href="../../entity/Entity.html" title="class in net.minestom.server.entity">Entity</a> entity)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the location based on the relative fields and <code>entity</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRelativeX()">isRelativeX</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets if the 'x' field is relative.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRelativeY()">isRelativeY</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets if the 'y' field is relative.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRelativeZ()">isRelativeZ</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets if the 'z' field is relative.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li class="blockList">
|
|
<section class="fieldDetails"><a id="field.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Field Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="location">location</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a></span> <span class="memberName">location</span></div>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="relativeX">relativeX</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">relativeX</span></div>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="relativeY">relativeY</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">relativeY</span></div>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="relativeZ">relativeZ</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">relativeZ</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorDetails"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>(java.lang.Object,boolean,boolean,boolean)">
|
|
<!-- -->
|
|
</a><a id="<init>(T,boolean,boolean,boolean)">RelativeLocation</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">RelativeLocation</span>​(<span class="arguments">@NotNull
|
|
<a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a> location,
|
|
boolean relativeX,
|
|
boolean relativeY,
|
|
boolean relativeZ)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="fromRelativePosition(net.minestom.server.entity.Entity)">fromRelativePosition</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType"><a href="RelativeLocation.html" title="type parameter in RelativeLocation">T</a></span> <span class="memberName">fromRelativePosition</span>​(<span class="arguments">@Nullable
|
|
<a href="../../entity/Entity.html" title="class in net.minestom.server.entity">Entity</a> entity)</span></div>
|
|
<div class="block">Gets the location based on the relative fields and <code>entity</code>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>entity</code> - the entity to get the relative position from</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the location</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="isRelativeX()">isRelativeX</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isRelativeX</span>()</div>
|
|
<div class="block">Gets if the 'x' field is relative.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the 'x' field is relative</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="isRelativeY()">isRelativeY</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isRelativeY</span>()</div>
|
|
<div class="block">Gets if the 'y' field is relative.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the 'y' field is relative</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="isRelativeZ()">isRelativeZ</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isRelativeZ</span>()</div>
|
|
<div class="block">Gets if the 'z' field is relative.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the 'z' field is relative</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|