AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-12-28 21:07:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
old-website
Scissors-Website/public/javadoc/1.18.2/org/bukkit/boss/DragonBattle.html
Telesphoreo 21e269497a Add Javadocs
2022-07-05 18:33:56 -05:00

295 lines
19 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>DragonBattle (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.boss, interface: DragonBattle">
<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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.boss</a></div>
<h1 title="Interface DragonBattle" class="title">Interface DragonBattle</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DragonBattle</span></div>
<div class="block">Represents a dragon battle state for a world with an end environment.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="DragonBattle.RespawnPhase.html" class="type-name-link" title="enum class in org.bukkit.boss">DragonBattle.RespawnPhase</a></code></div>
<div class="col-last even-row-color">
<div class="block">Represents a phase in the dragon respawn process.</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></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-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#generateEndPortal(boolean)" class="member-name-link">generateEndPortal</a><wbr>(boolean&nbsp;withPortals)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Generate the end portal.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BossBar.html" title="interface in org.bukkit.boss">BossBar</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBossBar()" class="member-name-link">getBossBar</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the boss bar to be displayed for this dragon battle.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../entity/EnderDragon.html" title="interface in org.bukkit.entity">EnderDragon</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEnderDragon()" class="member-name-link">getEnderDragon</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the <a href="../entity/EnderDragon.html" title="interface in org.bukkit.entity"><code>EnderDragon</code></a> active in this battle.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Location.html" title="class in org.bukkit">Location</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEndPortalLocation()" class="member-name-link">getEndPortalLocation</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the location of the end portal.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="DragonBattle.RespawnPhase.html" title="enum class in org.bukkit.boss">DragonBattle.RespawnPhase</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRespawnPhase()" class="member-name-link">getRespawnPhase</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get this battle's current respawn phase.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasBeenPreviouslyKilled()" class="member-name-link">hasBeenPreviouslyKilled</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Check whether or not the first dragon has been killed already.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#initiateRespawn()" class="member-name-link">initiateRespawn</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Initiate a respawn sequence to summon the dragon as though a player has
placed 4 end crystals on the portal.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resetCrystals()" class="member-name-link">resetCrystals</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Reset the crystals located on the obsidian pillars (remove their beam
targets and invulnerability).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setRespawnPhase(org.bukkit.boss.DragonBattle.RespawnPhase)" class="member-name-link">setRespawnPhase</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="DragonBattle.RespawnPhase.html" title="enum class in org.bukkit.boss">DragonBattle.RespawnPhase</a>&nbsp;phase)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the dragon's respawn phase.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getEnderDragon()">
<h3>getEnderDragon</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../entity/EnderDragon.html" title="interface in org.bukkit.entity">EnderDragon</a></span>&nbsp;<span class="element-name">getEnderDragon</span>()</div>
<div class="block">Get the <a href="../entity/EnderDragon.html" title="interface in org.bukkit.entity"><code>EnderDragon</code></a> active in this battle.
Will return null if the dragon has been slain.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ender dragon. null if dead</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBossBar()">
<h3>getBossBar</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BossBar.html" title="interface in org.bukkit.boss">BossBar</a></span>&nbsp;<span class="element-name">getBossBar</span>()</div>
<div class="block">Get the boss bar to be displayed for this dragon battle.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the boss bar</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getEndPortalLocation()">
<h3>getEndPortalLocation</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Location.html" title="class in org.bukkit">Location</a></span>&nbsp;<span class="element-name">getEndPortalLocation</span>()</div>
<div class="block">Get the location of the end portal.
This location will be at the center of the base (bottom) of the portal.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the end portal location or null if not generated</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="generateEndPortal(boolean)">
<h3>generateEndPortal</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">generateEndPortal</span><wbr><span class="parameters">(boolean&nbsp;withPortals)</span></div>
<div class="block">Generate the end portal.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>withPortals</code> - whether or not end portal blocks should be generated</dd>
<dt>Returns:</dt>
<dd>true if generated, false if already present</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasBeenPreviouslyKilled()">
<h3>hasBeenPreviouslyKilled</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">hasBeenPreviouslyKilled</span>()</div>
<div class="block">Check whether or not the first dragon has been killed already.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if killed before, false otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="initiateRespawn()">
<h3>initiateRespawn</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">initiateRespawn</span>()</div>
<div class="block">Initiate a respawn sequence to summon the dragon as though a player has
placed 4 end crystals on the portal.</div>
</section>
</li>
<li>
<section class="detail" id="getRespawnPhase()">
<h3>getRespawnPhase</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="DragonBattle.RespawnPhase.html" title="enum class in org.bukkit.boss">DragonBattle.RespawnPhase</a></span>&nbsp;<span class="element-name">getRespawnPhase</span>()</div>
<div class="block">Get this battle's current respawn phase.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the current respawn phase.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setRespawnPhase(org.bukkit.boss.DragonBattle.RespawnPhase)">
<h3>setRespawnPhase</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setRespawnPhase</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="DragonBattle.RespawnPhase.html" title="enum class in org.bukkit.boss">DragonBattle.RespawnPhase</a>&nbsp;phase)</span></div>
<div class="block">Set the dragon's respawn phase.
This method will is unsuccessful if a dragon respawn is not in progress.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>phase</code> - the phase to set</dd>
<dt>Returns:</dt>
<dd>true if successful, false otherwise</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#initiateRespawn()"><code>initiateRespawn()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="resetCrystals()">
<h3>resetCrystals</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">resetCrystals</span>()</div>
<div class="block">Reset the crystals located on the obsidian pillars (remove their beam
targets and invulnerability).</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink