mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-11-06 01:26:06 +00:00
2019 lines
184 KiB
HTML
2019 lines
184 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (17) -->
|
||
|
|
<title>Location (Scissors-API 1.18.2-R0.1-SNAPSHOT API)</title>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<meta name="description" content="declaration: package: org.bukkit, class: Location">
|
||
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||
|
|
<script type="text/javascript" src="../../script.js"></script>
|
||
|
|
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||
|
|
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||
|
|
</head>
|
||
|
|
<body class="class-declaration-page">
|
||
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||
|
|
var oddRowColor = "odd-row-color";
|
||
|
|
var tableTab = "table-tab";
|
||
|
|
var activeTableTab = "active-table-tab";
|
||
|
|
var pathtoroot = "../../";
|
||
|
|
loadScripts(document, 'script');</script>
|
||
|
|
<noscript>
|
||
|
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
|
</noscript>
|
||
|
|
<div class="flex-box">
|
||
|
|
<header role="banner" class="flex-header">
|
||
|
|
<nav role="navigation">
|
||
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
|
<div class="top-nav" id="navbar-top">
|
||
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||
|
|
<li><a href="../../index.html">Overview</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
||
|
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
||
|
|
<li><a href="../../index-all.html">Index</a></li>
|
||
|
|
<li><a href="../../help-doc.html#class">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="sub-nav">
|
||
|
|
<div>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li>Nested | </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method-summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
||
|
|
<li><a href="#method-detail">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
||
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||
|
|
</header>
|
||
|
|
<div class="flex-content">
|
||
|
|
<main role="main">
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.bukkit</a></div>
|
||
|
|
<h1 title="Class Location" class="title">Class Location</h1>
|
||
|
|
</div>
|
||
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||
|
|
<div class="inheritance">org.bukkit.Location</div>
|
||
|
|
</div>
|
||
|
|
<section class="class-description" id="class-description">
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>All Implemented Interfaces:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Location</span>
|
||
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
||
|
|
implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a>, <a href="configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></span></div>
|
||
|
|
<div class="block">Represents a 3-dimensional position in a world.
|
||
|
|
<br>
|
||
|
|
No constraints are placed on any angular values other than that they be
|
||
|
|
specified in degrees. This means that negative angles or angles of greater
|
||
|
|
magnitude than 360 are valid, but may be normalized to any other equivalent
|
||
|
|
representation by the implementation.</div>
|
||
|
|
</section>
|
||
|
|
<section class="summary">
|
||
|
|
<ul class="summary-list">
|
||
|
|
<!-- ======== 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(org.bukkit.World,double,double,double)" class="member-name-link">Location</a><wbr>(<a href="World.html" title="interface in org.bukkit">World</a> world,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z)</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Constructs a new Location with the given coordinates</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.World,double,double,double,float,float)" class="member-name-link">Location</a><wbr>(<a href="World.html" title="interface in org.bukkit">World</a> world,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z,
|
||
|
|
float yaw,
|
||
|
|
float pitch)</code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Constructs a new Location with the given coordinates and direction</div>
|
||
|
|
</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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
|
||
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||
|
|
<div class="table-header col-first">Modifier and Type</div>
|
||
|
|
<div class="table-header col-second">Method</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(double,double,double)" class="member-name-link">add</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">Adds the location by another.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.bukkit.Location)" class="member-name-link">add</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> vec)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Adds the location by another.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.bukkit.Location,double,double,double)" class="member-name-link">add</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> base,
|
||
|
|
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">Takes the x/y/z from base and adds the specified x/y/z to it and returns self
|
||
|
|
|
||
|
|
This mutates this object, clone first.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.bukkit.util.Vector)" class="member-name-link">add</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> vec)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Adds the location by a vector.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFinite()" class="member-name-link">checkFinite</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Check if each component of this Location is finite.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</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>boolean</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createExplosion(float)" class="member-name-link">createExplosion</a><wbr>(float power)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power
|
||
|
|
|
||
|
|
Will break blocks and ignite blocks on fire.</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="#createExplosion(float,boolean)" class="member-name-link">createExplosion</a><wbr>(float power,
|
||
|
|
boolean setFire)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire.</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="#createExplosion(float,boolean,boolean)" class="member-name-link">createExplosion</a><wbr>(float power,
|
||
|
|
boolean setFire,
|
||
|
|
boolean breakBlocks)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire.</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="#createExplosion(org.bukkit.entity.Entity,float,boolean,boolean)" class="member-name-link">createExplosion</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="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power,
|
||
|
|
boolean setFire,
|
||
|
|
boolean breakBlocks)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire, with the specified entity as the source.</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="#createExplosion(org.bukkit.entity.Entity,float)" class="member-name-link">createExplosion</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power, with the specified entity as the source.</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="#createExplosion(org.bukkit.entity.Entity,float,boolean)" class="member-name-link">createExplosion</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power,
|
||
|
|
boolean setFire)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire, with the specified entity as the source.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deserialize(java.util.Map)" class="member-name-link">deserialize</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> args)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||
|
|
<div class="block">Required method for deserialization</div>
|
||
|
|
</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="#distance(org.bukkit.Location)" class="member-name-link">distance</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> o)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Get the distance between this location and another.</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="#distanceSquared(org.bukkit.Location)" class="member-name-link">distanceSquared</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> o)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Get the squared distance between this location and another.</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="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</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><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/Block.html" title="interface in org.bukkit.block">Block</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlock()" class="member-name-link">getBlock</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the block at the represented location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlockX()" class="member-name-link">getBlockX</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the floored value of the X component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlockY()" class="member-name-link">getBlockY</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the floored value of the Y component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlockZ()" class="member-name-link">getBlockZ</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the floored value of the Z component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Chunk.html" title="interface in org.bukkit">Chunk</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChunk()" class="member-name-link">getChunk</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the chunk at the represented location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDirection()" class="member-name-link">getDirection</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets a unit-vector pointing in the direction that this Location is
|
||
|
|
facing.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntities(double,double,double)" class="member-name-link">getNearbyEntities</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">Returns a list of entities within a bounding box centered around a Location.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double,double,double,java.util.function.Predicate)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>> clazz,
|
||
|
|
double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double radius)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double,double)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xzRadius,
|
||
|
|
double yRadius)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double,double,double)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double,double,java.util.function.Predicate)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>><br><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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyEntitiesByType(java.lang.Class,double,java.util.function.Predicate)" class="member-name-link">getNearbyEntitiesByType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double radius)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double,double)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double xzRadius,
|
||
|
|
double yRadius)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double,double,double)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double,double,double,java.util.function.Predicate)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double,double,java.util.function.Predicate)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyLivingEntities(double,java.util.function.Predicate)" class="member-name-link">getNearbyLivingEntities</a><wbr>(double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double)" class="member-name-link">getNearbyPlayers</a><wbr>(double radius)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double,double)" class="member-name-link">getNearbyPlayers</a><wbr>(double xzRadius,
|
||
|
|
double yRadius)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double,double,double)" class="member-name-link">getNearbyPlayers</a><wbr>(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double,double,double,java.util.function.Predicate)" class="member-name-link">getNearbyPlayers</a><wbr>(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double,double,java.util.function.Predicate)" class="member-name-link">getNearbyPlayers</a><wbr>(double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNearbyPlayers(double,java.util.function.Predicate)" class="member-name-link">getNearbyPlayers</a><wbr>(double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPitch()" class="member-name-link">getPitch</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the pitch of this location, measured in degrees.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><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-tab4">
|
||
|
|
<div class="block">Gets the world that this location resides in</div>
|
||
|
|
</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="#getX()" class="member-name-link">getX</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the x-coordinate of this location</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="#getY()" class="member-name-link">getY</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the y-coordinate of this location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getYaw()" class="member-name-link">getYaw</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the yaw of this location, measured in degrees.</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="#getZ()" class="member-name-link">getZ</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the z-coordinate of this location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</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>boolean</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isChunkLoaded()" class="member-name-link">isChunkLoaded</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="#isGenerated()" class="member-name-link">isGenerated</a>()</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 a <a href="Chunk.html" title="interface in org.bukkit"><code>Chunk</code></a> has been generated at this location.</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="#isWorldLoaded()" class="member-name-link">isWorldLoaded</a>()</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 world in this location is present and loaded.</div>
|
||
|
|
</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="#length()" class="member-name-link">length</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2).</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="#lengthSquared()" class="member-name-link">lengthSquared</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the magnitude of the location squared.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#locToBlock(double)" class="member-name-link">locToBlock</a><wbr>(double loc)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||
|
|
<div class="block">Safely converts a double (location coordinate) to an int (block
|
||
|
|
coordinate)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#multiply(double)" class="member-name-link">multiply</a><wbr>(double m)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Performs scalar multiplication, multiplying all components with a
|
||
|
|
scalar.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizePitch(float)" class="member-name-link">normalizePitch</a><wbr>(float pitch)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||
|
|
<div class="block">Normalizes the given pitch angle to a value between <code>+/-90</code>
|
||
|
|
degrees.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static float</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizeYaw(float)" class="member-name-link">normalizeYaw</a><wbr>(float yaw)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||
|
|
<div class="block">Normalizes the given yaw angle to a value between <code>+/-180</code>
|
||
|
|
degrees.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serialize()" class="member-name-link">serialize</a>()</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 Map representation of this class.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double,double,double)" class="member-name-link">set</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">Sets the position of this Location and returns itself
|
||
|
|
|
||
|
|
This mutates this object, clone first.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDirection(org.bukkit.util.Vector)" class="member-name-link">setDirection</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> vector)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the <a href="#getYaw()"><code>yaw</code></a> and <a href="#getPitch()"><code>pitch</code></a> to point
|
||
|
|
in the direction of the vector.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPitch(float)" class="member-name-link">setPitch</a><wbr>(float pitch)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the pitch of this location, measured in degrees.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setWorld(org.bukkit.World)" class="member-name-link">setWorld</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="World.html" title="interface in org.bukkit">World</a> world)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the world that this location resides in</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setX(double)" class="member-name-link">setX</a><wbr>(double x)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the x-coordinate of this location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setY(double)" class="member-name-link">setY</a><wbr>(double y)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the y-coordinate of this location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setYaw(float)" class="member-name-link">setYaw</a><wbr>(float yaw)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the yaw of this location, measured in degrees.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setZ(double)" class="member-name-link">setZ</a><wbr>(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">Sets the z-coordinate of this location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subtract(double,double,double)" class="member-name-link">subtract</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">Subtracts the location by another.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subtract(org.bukkit.Location)" class="member-name-link">subtract</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> vec)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Subtracts the location by another.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subtract(org.bukkit.Location,double,double,double)" class="member-name-link">subtract</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> base,
|
||
|
|
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">Takes the x/y/z from base and subtracts the specified x/y/z to it and returns self
|
||
|
|
|
||
|
|
This mutates this object, clone first.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subtract(org.bukkit.util.Vector)" class="member-name-link">subtract</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> vec)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Subtracts the location by a vector.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>long</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toBlockKey()" class="member-name-link">toBlockKey</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
||
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||
|
|
<div class="deprecation-comment">only encodes y block ranges from -512 to 511 and represents an already changed implementation detail</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toBlockLocation()" class="member-name-link">toBlockLocation</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><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></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toCenterLocation()" class="member-name-link">toCenterLocation</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><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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toHighestLocation()" class="member-name-link">toHighestLocation</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toHighestLocation(org.bukkit.HeightMap)" class="member-name-link">toHighestLocation</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="HeightMap.html" title="enum class in org.bukkit">HeightMap</a> heightMap)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toHighestLocation(com.destroystokyo.paper.HeightmapType)" class="member-name-link">toHighestLocation</a><wbr>(<a href="../../com/destroystokyo/paper/HeightmapType.html" title="enum class in com.destroystokyo.paper">HeightmapType</a> heightmap)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
||
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||
|
|
<div class="deprecation-comment">Use <a href="#toHighestLocation(org.bukkit.HeightMap)"><code>toHighestLocation(HeightMap)</code></a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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><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></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toVector()" class="member-name-link">toVector</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Constructs a new <a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> based on this Location</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zero()" class="member-name-link">zero</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Zero this location's components.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="details">
|
||
|
|
<ul class="details-list">
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="constructor-details" id="constructor-detail">
|
||
|
|
<h2>Constructor Details</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>(org.bukkit.World,double,double,double)">
|
||
|
|
<h3>Location</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Location</span><wbr><span class="parameters">(<a href="World.html" title="interface in org.bukkit">World</a> world,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Constructs a new Location with the given coordinates</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>world</code> - The world in which this location resides</dd>
|
||
|
|
<dd><code>x</code> - The x-coordinate of this new location</dd>
|
||
|
|
<dd><code>y</code> - The y-coordinate of this new location</dd>
|
||
|
|
<dd><code>z</code> - The z-coordinate of this new location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>(org.bukkit.World,double,double,double,float,float)">
|
||
|
|
<h3>Location</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Location</span><wbr><span class="parameters">(<a href="World.html" title="interface in org.bukkit">World</a> world,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z,
|
||
|
|
float yaw,
|
||
|
|
float pitch)</span></div>
|
||
|
|
<div class="block">Constructs a new Location with the given coordinates and direction</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>world</code> - The world in which this location resides</dd>
|
||
|
|
<dd><code>x</code> - The x-coordinate of this new location</dd>
|
||
|
|
<dd><code>y</code> - The y-coordinate of this new location</dd>
|
||
|
|
<dd><code>z</code> - The z-coordinate of this new location</dd>
|
||
|
|
<dd><code>yaw</code> - The absolute rotation on the x-plane, in degrees</dd>
|
||
|
|
<dd><code>pitch</code> - The absolute rotation on the y-plane, in degrees</dd>
|
||
|
|
</dl>
|
||
|
|
</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="setWorld(org.bukkit.World)">
|
||
|
|
<h3>setWorld</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWorld</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="World.html" title="interface in org.bukkit">World</a> world)</span></div>
|
||
|
|
<div class="block">Sets the world that this location resides in</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>world</code> - New world that this location resides in</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="isWorldLoaded()">
|
||
|
|
<h3>isWorldLoaded</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isWorldLoaded</span>()</div>
|
||
|
|
<div class="block">Checks if world in this location is present and loaded.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>true if is loaded, otherwise false</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getWorld()">
|
||
|
|
<h3>getWorld</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="World.html" title="interface in org.bukkit">World</a></span> <span class="element-name">getWorld</span>()</div>
|
||
|
|
<div class="block">Gets the world that this location resides in</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>World that contains this location, or <code>null</code> if it is not set</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when world is unloaded</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="#isWorldLoaded()"><code>isWorldLoaded()</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getChunk()">
|
||
|
|
<h3>getChunk</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Chunk.html" title="interface in org.bukkit">Chunk</a></span> <span class="element-name">getChunk</span>()</div>
|
||
|
|
<div class="block">Gets the chunk at the represented location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>Chunk at the represented location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getBlock()">
|
||
|
|
<h3>getBlock</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="block/Block.html" title="interface in org.bukkit.block">Block</a></span> <span class="element-name">getBlock</span>()</div>
|
||
|
|
<div class="block">Gets the block at the represented location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>Block at the represented location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setX(double)">
|
||
|
|
<h3>setX</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setX</span><wbr><span class="parameters">(double x)</span></div>
|
||
|
|
<div class="block">Sets the x-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>x</code> - X-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getX()">
|
||
|
|
<h3>getX</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getX</span>()</div>
|
||
|
|
<div class="block">Gets the x-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>x-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getBlockX()">
|
||
|
|
<h3>getBlockX</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBlockX</span>()</div>
|
||
|
|
<div class="block">Gets the floored value of the X component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>block X</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setY(double)">
|
||
|
|
<h3>setY</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setY</span><wbr><span class="parameters">(double y)</span></div>
|
||
|
|
<div class="block">Sets the y-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>y</code> - y-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getY()">
|
||
|
|
<h3>getY</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getY</span>()</div>
|
||
|
|
<div class="block">Gets the y-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>y-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getBlockY()">
|
||
|
|
<h3>getBlockY</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBlockY</span>()</div>
|
||
|
|
<div class="block">Gets the floored value of the Y component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>block y</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setZ(double)">
|
||
|
|
<h3>setZ</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setZ</span><wbr><span class="parameters">(double z)</span></div>
|
||
|
|
<div class="block">Sets the z-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>z</code> - z-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getZ()">
|
||
|
|
<h3>getZ</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getZ</span>()</div>
|
||
|
|
<div class="block">Gets the z-coordinate of this location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>z-coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getBlockZ()">
|
||
|
|
<h3>getBlockZ</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBlockZ</span>()</div>
|
||
|
|
<div class="block">Gets the floored value of the Z component, indicating the block that
|
||
|
|
this location is contained with.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>block z</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setYaw(float)">
|
||
|
|
<h3>setYaw</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setYaw</span><wbr><span class="parameters">(float yaw)</span></div>
|
||
|
|
<div class="block">Sets the yaw of this location, measured in degrees.
|
||
|
|
<ul>
|
||
|
|
<li>A yaw of 0 or 360 represents the positive z direction.
|
||
|
|
<li>A yaw of 180 represents the negative z direction.
|
||
|
|
<li>A yaw of 90 represents the negative x direction.
|
||
|
|
<li>A yaw of 270 represents the positive x direction.
|
||
|
|
</ul>
|
||
|
|
Increasing yaw values are the equivalent of turning to your
|
||
|
|
right-facing, increasing the scale of the next respective axis, and
|
||
|
|
decreasing the scale of the previous axis.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>yaw</code> - new rotation's yaw</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getYaw()">
|
||
|
|
<h3>getYaw</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getYaw</span>()</div>
|
||
|
|
<div class="block">Gets the yaw of this location, measured in degrees.
|
||
|
|
<ul>
|
||
|
|
<li>A yaw of 0 or 360 represents the positive z direction.
|
||
|
|
<li>A yaw of 180 represents the negative z direction.
|
||
|
|
<li>A yaw of 90 represents the negative x direction.
|
||
|
|
<li>A yaw of 270 represents the positive x direction.
|
||
|
|
</ul>
|
||
|
|
Increasing yaw values are the equivalent of turning to your
|
||
|
|
right-facing, increasing the scale of the next respective axis, and
|
||
|
|
decreasing the scale of the previous axis.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the rotation's yaw</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setPitch(float)">
|
||
|
|
<h3>setPitch</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPitch</span><wbr><span class="parameters">(float pitch)</span></div>
|
||
|
|
<div class="block">Sets the pitch of this location, measured in degrees.
|
||
|
|
<ul>
|
||
|
|
<li>A pitch of 0 represents level forward facing.
|
||
|
|
<li>A pitch of 90 represents downward facing, or negative y
|
||
|
|
direction.
|
||
|
|
<li>A pitch of -90 represents upward facing, or positive y direction.
|
||
|
|
</ul>
|
||
|
|
Increasing pitch values the equivalent of looking down.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>pitch</code> - new incline's pitch</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getPitch()">
|
||
|
|
<h3>getPitch</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getPitch</span>()</div>
|
||
|
|
<div class="block">Gets the pitch of this location, measured in degrees.
|
||
|
|
<ul>
|
||
|
|
<li>A pitch of 0 represents level forward facing.
|
||
|
|
<li>A pitch of 90 represents downward facing, or negative y
|
||
|
|
direction.
|
||
|
|
<li>A pitch of -90 represents upward facing, or positive y direction.
|
||
|
|
</ul>
|
||
|
|
Increasing pitch values the equivalent of looking down.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the incline's pitch</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getDirection()">
|
||
|
|
<h3>getDirection</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="util/Vector.html" title="class in org.bukkit.util">Vector</a></span> <span class="element-name">getDirection</span>()</div>
|
||
|
|
<div class="block">Gets a unit-vector pointing in the direction that this Location is
|
||
|
|
facing.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>a vector pointing the direction of this location's <a href="#getPitch()"><code>pitch</code></a> and <a href="#getYaw()"><code>yaw</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setDirection(org.bukkit.util.Vector)">
|
||
|
|
<h3>setDirection</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">setDirection</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> vector)</span></div>
|
||
|
|
<div class="block">Sets the <a href="#getYaw()"><code>yaw</code></a> and <a href="#getPitch()"><code>pitch</code></a> to point
|
||
|
|
in the direction of the vector.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>vector</code> - the direction vector</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="add(org.bukkit.Location)">
|
||
|
|
<h3>add</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">add</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> vec)</span></div>
|
||
|
|
<div class="block">Adds the location by another.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>vec</code> - The other location</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - for differing worlds</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="add(org.bukkit.util.Vector)">
|
||
|
|
<h3>add</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">add</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> vec)</span></div>
|
||
|
|
<div class="block">Adds the location by a vector.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>vec</code> - Vector to use</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="add(double,double,double)">
|
||
|
|
<h3>add</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">add</span><wbr><span class="parameters">(double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Adds the location by another. Not world-aware.</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>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="subtract(org.bukkit.Location)">
|
||
|
|
<h3>subtract</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">subtract</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> vec)</span></div>
|
||
|
|
<div class="block">Subtracts the location by another.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>vec</code> - The other location</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - for differing worlds</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="subtract(org.bukkit.util.Vector)">
|
||
|
|
<h3>subtract</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">subtract</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> vec)</span></div>
|
||
|
|
<div class="block">Subtracts the location by a vector.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>vec</code> - The vector to use</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="subtract(double,double,double)">
|
||
|
|
<h3>subtract</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">subtract</span><wbr><span class="parameters">(double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Subtracts the location by another. Not world-aware and
|
||
|
|
orientation independent.</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>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="length()">
|
||
|
|
<h3>length</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">length</span>()</div>
|
||
|
|
<div class="block">Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2). The
|
||
|
|
value of this method is not cached and uses a costly square-root
|
||
|
|
function, so do not repeatedly call this method to get the location's
|
||
|
|
magnitude. NaN will be returned if the inner result of the sqrt()
|
||
|
|
function overflows, which will be caused if the length is too long. Not
|
||
|
|
world-aware and orientation independent.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the magnitude</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="lengthSquared()">
|
||
|
|
<h3>lengthSquared</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">lengthSquared</span>()</div>
|
||
|
|
<div class="block">Gets the magnitude of the location squared. Not world-aware and
|
||
|
|
orientation independent.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the magnitude</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="distance(org.bukkit.Location)">
|
||
|
|
<h3>distance</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">distance</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> o)</span></div>
|
||
|
|
<div class="block">Get the distance between this location and another. The value of this
|
||
|
|
method is not cached and uses a costly square-root function, so do not
|
||
|
|
repeatedly call this method to get the location's magnitude. NaN will
|
||
|
|
be returned if the inner result of the sqrt() function overflows, which
|
||
|
|
will be caused if the distance is too long.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>o</code> - The other location</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the distance</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - for differing worlds</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="distanceSquared(org.bukkit.Location)">
|
||
|
|
<h3>distanceSquared</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">distanceSquared</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> o)</span></div>
|
||
|
|
<div class="block">Get the squared distance between this location and another.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>o</code> - The other location</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the distance</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - for differing worlds</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="multiply(double)">
|
||
|
|
<h3>multiply</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">multiply</span><wbr><span class="parameters">(double m)</span></div>
|
||
|
|
<div class="block">Performs scalar multiplication, multiplying all components with a
|
||
|
|
scalar. Not world-aware.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>m</code> - The factor</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="zero()">
|
||
|
|
<h3>zero</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">zero</span>()</div>
|
||
|
|
<div class="block">Zero this location's components. Not world-aware.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the same location</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="isChunkLoaded()">
|
||
|
|
<h3>isChunkLoaded</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isChunkLoaded</span>()</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="isGenerated()">
|
||
|
|
<h3>isGenerated</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isGenerated</span>()</div>
|
||
|
|
<div class="block">Checks if a <a href="Chunk.html" title="interface in org.bukkit"><code>Chunk</code></a> has been generated at this location.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>true if a chunk has been generated at this location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="set(double,double,double)">
|
||
|
|
<h3>set</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">set</span><wbr><span class="parameters">(double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Sets the position of this Location and returns itself
|
||
|
|
|
||
|
|
This mutates this object, clone first.</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>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>self (not cloned)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="add(org.bukkit.Location,double,double,double)">
|
||
|
|
<h3>add</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">add</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> base,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Takes the x/y/z from base and adds the specified x/y/z to it and returns self
|
||
|
|
|
||
|
|
This mutates this object, clone first.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>base</code> - The base coordinate to modify</dd>
|
||
|
|
<dd><code>x</code> - X coordinate to add to base</dd>
|
||
|
|
<dd><code>y</code> - Y coordinate to add to base</dd>
|
||
|
|
<dd><code>z</code> - Z coordinate to add to base</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>self (not cloned)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="subtract(org.bukkit.Location,double,double,double)">
|
||
|
|
<h3>subtract</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">subtract</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> base,
|
||
|
|
double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Takes the x/y/z from base and subtracts the specified x/y/z to it and returns self
|
||
|
|
|
||
|
|
This mutates this object, clone first.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>base</code> - The base coordinate to modify</dd>
|
||
|
|
<dd><code>x</code> - X coordinate to subtract from base</dd>
|
||
|
|
<dd><code>y</code> - Y coordinate to subtract from base</dd>
|
||
|
|
<dd><code>z</code> - Z coordinate to subtract from base</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>self (not cloned)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toBlockLocation()">
|
||
|
|
<h3>toBlockLocation</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">toBlockLocation</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>A new location where X/Y/Z are on the Block location (integer value of X/Y/Z)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toBlockKey()">
|
||
|
|
<h3>toBlockKey</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">toBlockKey</span>()</div>
|
||
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||
|
|
<div class="deprecation-comment">only encodes y block ranges from -512 to 511 and represents an already changed implementation detail</div>
|
||
|
|
</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The block key for this location's block location.</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list-long">
|
||
|
|
<li><a href="block/Block.html#getBlockKey(int,int,int)"><code>Block.getBlockKey(int, int, int)</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toCenterLocation()">
|
||
|
|
<h3>toCenterLocation</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">toCenterLocation</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>A new location where X/Y/Z are the center of the block</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toHighestLocation()">
|
||
|
|
<h3>toHighestLocation</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">toHighestLocation</span>()</div>
|
||
|
|
<div class="block">Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if {<a href="#getWorld()"><code>getWorld()</code></a>} is <code>null</code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toHighestLocation(com.destroystokyo.paper.HeightmapType)">
|
||
|
|
<h3>toHighestLocation</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">toHighestLocation</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="../../com/destroystokyo/paper/HeightmapType.html" title="enum class in com.destroystokyo.paper">HeightmapType</a> heightmap)</span></div>
|
||
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||
|
|
<div class="deprecation-comment">Use <a href="#toHighestLocation(org.bukkit.HeightMap)"><code>toHighestLocation(HeightMap)</code></a></div>
|
||
|
|
</div>
|
||
|
|
<div class="block">Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightmap)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>heightmap</code> - The heightmap to use for finding the highest y location.</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightmap)</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if {<a href="#getWorld()"><code>getWorld()</code></a>} is <code>null</code></dd>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if <a href="World.html#getHighestBlockYAt(int,int,com.destroystokyo.paper.HeightmapType)"><code>World.getHighestBlockYAt(int, int, com.destroystokyo.paper.HeightmapType)</code></a> does not support the specified heightmap</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="toHighestLocation(org.bukkit.HeightMap)">
|
||
|
|
<h3>toHighestLocation</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">toHighestLocation</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="HeightMap.html" title="enum class in org.bukkit">HeightMap</a> heightMap)</span></div>
|
||
|
|
<div class="block">Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>heightMap</code> - The heightmap to use for finding the highest y location.</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(float)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</span><wbr><span class="parameters">(float power)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power
|
||
|
|
|
||
|
|
Will break blocks and ignite blocks on fire.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(float,boolean)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</span><wbr><span class="parameters">(float power,
|
||
|
|
boolean setFire)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire.
|
||
|
|
|
||
|
|
Will break blocks.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dd><code>setFire</code> - Whether or not to set blocks on fire</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(float,boolean,boolean)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</span><wbr><span class="parameters">(float power,
|
||
|
|
boolean setFire,
|
||
|
|
boolean breakBlocks)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dd><code>setFire</code> - Whether or not to set blocks on fire</dd>
|
||
|
|
<dd><code>breakBlocks</code> - Whether or not to have blocks be destroyed</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(org.bukkit.entity.Entity,float)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power, with the specified entity as the source.
|
||
|
|
|
||
|
|
Will break blocks and ignite blocks on fire.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>source</code> - The source entity of the explosion</dd>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(org.bukkit.entity.Entity,float,boolean)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power,
|
||
|
|
boolean setFire)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire, with the specified entity as the source.
|
||
|
|
|
||
|
|
Will break blocks.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>source</code> - The source entity of the explosion</dd>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dd><code>setFire</code> - Whether or not to set blocks on fire</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="createExplosion(org.bukkit.entity.Entity,float,boolean,boolean)">
|
||
|
|
<h3>createExplosion</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createExplosion</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="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> source,
|
||
|
|
float power,
|
||
|
|
boolean setFire,
|
||
|
|
boolean breakBlocks)</span></div>
|
||
|
|
<div class="block">Creates explosion at this location with given power and optionally
|
||
|
|
setting blocks on fire, with the specified entity as the source.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>source</code> - The source entity of the explosion</dd>
|
||
|
|
<dd><code>power</code> - The power of explosion, where 4F is TNT</dd>
|
||
|
|
<dd><code>setFire</code> - Whether or not to set blocks on fire</dd>
|
||
|
|
<dd><code>breakBlocks</code> - Whether or not to have blocks be destroyed</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>false if explosion was canceled, otherwise true</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntities(double,double,double)">
|
||
|
|
<h3>getNearbyEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>></span> <span class="element-name">getNearbyEntities</span><wbr><span class="parameters">(double x,
|
||
|
|
double y,
|
||
|
|
double z)</span></div>
|
||
|
|
<div class="block">Returns a list of entities within a bounding box centered around a Location.
|
||
|
|
|
||
|
|
Some implementations may impose artificial restrictions on the size of the search bounding box.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>x</code> - 1/2 the size of the box along x axis</dd>
|
||
|
|
<dd><code>y</code> - 1/2 the size of the box along y axis</dd>
|
||
|
|
<dd><code>z</code> - 1/2 the size of the box along z axis</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double radius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>radius</code> - X Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double,double)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double xzRadius,
|
||
|
|
double yRadius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xzRadius</code> - X/Z Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of living entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double,double,double)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of living entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>radius</code> - Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of living entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xzRadius</code> - X/Z Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of living entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyLivingEntities(double,double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyLivingEntities</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>></span> <span class="element-name">getNearbyLivingEntities</span><wbr><span class="parameters">(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/LivingEntity.html" title="interface in org.bukkit.entity">LivingEntity</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of living entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double radius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>radius</code> - X/Y/Z Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double,double)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double xzRadius,
|
||
|
|
double yRadius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xzRadius</code> - X/Z Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double,double,double)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>radius</code> - X/Y/Z Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xzRadius</code> - X/Z Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyPlayers(double,double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyPlayers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>></span> <span class="element-name">getNearbyPlayers</span><wbr><span class="parameters">(double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="entity/Player.html" title="interface in org.bukkit.entity">Player</a>> predicate)</span></div>
|
||
|
|
<div class="block">Gets nearby players within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of players near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double radius)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>radius</code> - X/Y/Z radius to search within</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities of type clazz near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double,double)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xzRadius,
|
||
|
|
double yRadius)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>xzRadius</code> - X/Z radius to search within</dd>
|
||
|
|
<dd><code>yRadius</code> - Y radius to search within</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double,double,double)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z Radius</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double radius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>radius</code> - X/Y/Z radius to search within</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends T> clazz,
|
||
|
|
double xzRadius,
|
||
|
|
double yRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>xzRadius</code> - X/Z radius to search within</dd>
|
||
|
|
<dd><code>yRadius</code> - Y radius to search within</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getNearbyEntitiesByType(java.lang.Class,double,double,double,java.util.function.Predicate)">
|
||
|
|
<h3>getNearbyEntitiesByType</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><T></span> <span class="element-name">getNearbyEntitiesByType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="entity/Entity.html" title="interface in org.bukkit.entity">Entity</a>> clazz,
|
||
|
|
double xRadius,
|
||
|
|
double yRadius,
|
||
|
|
double zRadius,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><T> predicate)</span></div>
|
||
|
|
<div class="block">Gets all nearby entities of the specified type, within the specified radius (bounding box)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Type Parameters:</dt>
|
||
|
|
<dd><code>T</code> - the entity type</dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>clazz</code> - Type to filter by</dd>
|
||
|
|
<dd><code>xRadius</code> - X Radius</dd>
|
||
|
|
<dd><code>yRadius</code> - Y Radius</dd>
|
||
|
|
<dd><code>zRadius</code> - Z Radius</dd>
|
||
|
|
<dd><code>predicate</code> - a predicate used to filter results</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the collection of entities near location. This will always be a non-null collection.</dd>
|
||
|
|
</dl>
|
||
|
|
</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/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Overrides:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="hashCode()">
|
||
|
|
<h3>hashCode</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Overrides:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></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/17/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/17/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/17/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="toVector()">
|
||
|
|
<h3>toVector</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="util/Vector.html" title="class in org.bukkit.util">Vector</a></span> <span class="element-name">toVector</span>()</div>
|
||
|
|
<div class="block">Constructs a new <a href="util/Vector.html" title="class in org.bukkit.util"><code>Vector</code></a> based on this Location</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>New Vector containing the coordinates represented by this
|
||
|
|
Location</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="clone()">
|
||
|
|
<h3>clone</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">clone</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Overrides:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="checkFinite()">
|
||
|
|
<h3>checkFinite</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkFinite</span>()
|
||
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
|
||
|
|
<div class="block">Check if each component of this Location is finite.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if any component is not finite</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="locToBlock(double)">
|
||
|
|
<h3>locToBlock</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">locToBlock</span><wbr><span class="parameters">(double loc)</span></div>
|
||
|
|
<div class="block">Safely converts a double (location coordinate) to an int (block
|
||
|
|
coordinate)</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>loc</code> - Precise coordinate</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>Block coordinate</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="serialize()">
|
||
|
|
<h3>serialize</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">serialize</span>()</div>
|
||
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="configuration/serialization/ConfigurationSerializable.html#serialize()">ConfigurationSerializable</a></code></span></div>
|
||
|
|
<div class="block">Creates a Map representation of this class.
|
||
|
|
<p>
|
||
|
|
This class must provide a method to restore this class, as defined in
|
||
|
|
the <a href="configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization"><code>ConfigurationSerializable</code></a> interface javadocs.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="configuration/serialization/ConfigurationSerializable.html#serialize()">serialize</a></code> in interface <code><a href="configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></code></dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>Map containing the current state of this class</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="deserialize(java.util.Map)">
|
||
|
|
<h3>deserialize</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public static</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="Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">deserialize</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> args)</span></div>
|
||
|
|
<div class="block">Required method for deserialization</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>args</code> - map to deserialize</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>deserialized location</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the world don't exists</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization"><code>ConfigurationSerializable</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="normalizeYaw(float)">
|
||
|
|
<h3>normalizeYaw</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">float</span> <span class="element-name">normalizeYaw</span><wbr><span class="parameters">(float yaw)</span></div>
|
||
|
|
<div class="block">Normalizes the given yaw angle to a value between <code>+/-180</code>
|
||
|
|
degrees.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>yaw</code> - the yaw in degrees</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the normalized yaw in degrees</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="#getYaw()"><code>getYaw()</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="normalizePitch(float)">
|
||
|
|
<h3>normalizePitch</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">float</span> <span class="element-name">normalizePitch</span><wbr><span class="parameters">(float pitch)</span></div>
|
||
|
|
<div class="block">Normalizes the given pitch angle to a value between <code>+/-90</code>
|
||
|
|
degrees.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>pitch</code> - the pitch in degrees</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>the normalized pitch in degrees</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="#getPitch()"><code>getPitch()</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
</main>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|