mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-09-20 22:28:14 +00:00
326 lines
29 KiB
HTML
326 lines
29 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (17) -->
|
||
|
<title>FireworkMeta (Scissors-API 1.17.1-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.inventory.meta, interface: FireworkMeta">
|
||
|
<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>Constr | </li>
|
||
|
<li><a href="#method-summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="sub-nav-list">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </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.inventory.meta</a></div>
|
||
|
<h1 title="Interface FireworkMeta" class="title">Interface FireworkMeta</h1>
|
||
|
</div>
|
||
|
<section class="class-description" id="class-description">
|
||
|
<dl class="notes">
|
||
|
<dt>All Superinterfaces:</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>, <code><a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></code>, <code><a href="../../persistence/PersistentDataHolder.html" title="interface in org.bukkit.persistence">PersistentDataHolder</a></code></dd>
|
||
|
</dl>
|
||
|
<hr>
|
||
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">FireworkMeta</span><span class="extends-implements">
|
||
|
extends <a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></span></div>
|
||
|
<div class="block">Represents a <a href="../../Material.html#FIREWORK_ROCKET"><code>Material.FIREWORK_ROCKET</code></a> and its effects.</div>
|
||
|
</section>
|
||
|
<section class="summary">
|
||
|
<ul class="summary-list">
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<li>
|
||
|
<section class="method-summary" id="method-summary">
|
||
|
<h2>Method Summary</h2>
|
||
|
<div id="method-summary-table">
|
||
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></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>void</code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addEffect(org.bukkit.FireworkEffect)" class="member-name-link">addEffect</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a> effect)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Add another effect to this firework.</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="#addEffects(java.lang.Iterable)" class="member-name-link">addEffects</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>> effects)</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Add several firework effects to this firework.</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="#addEffects(org.bukkit.FireworkEffect...)" class="member-name-link">addEffects</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>... effects)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Add several effects to this firework.</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="#clearEffects()" class="member-name-link">clearEffects</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Remove all effects from this firework.</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="FireworkMeta.html" title="interface in org.bukkit.inventory.meta">FireworkMeta</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>></code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEffects()" class="member-name-link">getEffects</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 effects in this firework.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEffectsSize()" class="member-name-link">getEffectsSize</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 number of effects in this firework.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPower()" class="member-name-link">getPower</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the approximate height the firework will fly.</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="#hasEffects()" class="member-name-link">hasEffects</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 whether this firework has any effects.</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="#removeEffect(int)" class="member-name-link">removeEffect</a><wbr>(int index)</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Remove an effect from this firework.</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="#setPower(int)" class="member-name-link">setPower</a><wbr>(int power)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Sets the approximate power of the firework.</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="inherited-list">
|
||
|
<h3 id="methods-inherited-from-class-org.bukkit.configuration.serialization.ConfigurationSerializable">Methods inherited from interface org.bukkit.configuration.serialization.<a href="../../configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></h3>
|
||
|
<code><a href="../../configuration/serialization/ConfigurationSerializable.html#serialize()">serialize</a></code></div>
|
||
|
<div class="inherited-list">
|
||
|
<h3 id="methods-inherited-from-class-org.bukkit.inventory.meta.ItemMeta">Methods inherited from interface org.bukkit.inventory.meta.<a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></h3>
|
||
|
<code><a href="ItemMeta.html#addAttributeModifier(org.bukkit.attribute.Attribute,org.bukkit.attribute.AttributeModifier)">addAttributeModifier</a>, <a href="ItemMeta.html#addEnchant(org.bukkit.enchantments.Enchantment,int,boolean)">addEnchant</a>, <a href="ItemMeta.html#addItemFlags(org.bukkit.inventory.ItemFlag...)">addItemFlags</a>, <a href="ItemMeta.html#displayName()">displayName</a>, <a href="ItemMeta.html#displayName(net.kyori.adventure.text.Component)">displayName</a>, <a href="ItemMeta.html#getAttributeModifiers()">getAttributeModifiers</a>, <a href="ItemMeta.html#getAttributeModifiers(org.bukkit.attribute.Attribute)">getAttributeModifiers</a>, <a href="ItemMeta.html#getAttributeModifiers(org.bukkit.inventory.EquipmentSlot)">getAttributeModifiers</a>, <a href="ItemMeta.html#getCanDestroy()">getCanDestroy</a>, <a href="ItemMeta.html#getCanPlaceOn()">getCanPlaceOn</a>, <a href="ItemMeta.html#getCustomModelData()">getCustomModelData</a>, <a href="ItemMeta.html#getCustomTagContainer()">getCustomTagContainer</a>, <a href="ItemMeta.html#getDestroyableKeys()">getDestroyableKeys</a>, <a href="ItemMeta.html#getDisplayName()">getDisplayName</a>, <a href="ItemMeta.html#getDisplayNameComponent()">getDisplayNameComponent</a>, <a href="ItemMeta.html#getEnchantLevel(org.bukkit.enchantments.Enchantment)">getEnchantLevel</a>, <a href="ItemMeta.html#getEnchants()">getEnchants</a>, <a href="ItemMeta.html#getItemFlags()">getItemFlags</a>, <a href="ItemMeta.html#getLocalizedName()">getLocalizedName</a>, <a href="ItemMeta.html#getLore()">getLore</a>, <a href="ItemMeta.html#getLoreComponents()">getLoreComponents</a>, <a href="ItemMeta.html#getPlaceableKeys()">getPlaceableKeys</a>, <a href="ItemMeta.html#hasAttributeModifiers()">hasAttributeModifiers</a>, <a href="ItemMeta.html#hasConflictingEnchant(org.bukkit.enchantments.Enchantment)">hasConflictingEnchant</a>, <a href="ItemMeta.html#hasCustomModelData()">hasCustomModelData</a>, <a href="ItemMeta.html#hasDestroyableKeys()">hasDestroyableKeys</a>, <a href="ItemMeta.html#hasDisplayName()">hasDisplayName</a>, <a href="ItemMeta.html#hasEnchant(org.bukkit.enchantments.Enchantment)">hasEnchant</a>, <a href="ItemMeta.html#hasEnchants()">hasEnchants</a>, <a href="ItemMeta.html#hasItemFlag(org.bukkit.inventory.ItemFlag)">hasItemFlag</a>, <a href="ItemMeta.html#hasLocalizedName()">hasLocalizedName</a>, <a href="ItemMeta.html#hasLore()">hasLore</a>, <a href="ItemMeta.html#hasPlaceableKeys()">hasPlaceableKeys</a>, <a href="ItemMeta.html#isUnbreakable()">isUnbreakable</a>, <a href="ItemMeta.html#lore()">lore</a>, <a href="ItemMeta.html#lore(java.util.List)">lore</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.attribute.Attribute)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.attribute.Attribute,org.bukkit.attribute.AttributeModifier)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.inventory.EquipmentSlot)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeEnchant(org.bukkit.enchantments.Enchantment)">removeEnchant</a>, <a href="ItemMeta.html#removeItemFlags(org.bukkit.inventory.ItemFlag...)">removeItemFlags</a>, <a href="ItemMeta.html#setAttributeModifiers(com.google.common.collect.Multimap)">setAttributeModifiers</a>, <a href="ItemMeta.html#setCanDestroy(java.util.Set)">setCanDestroy</a>, <a href="ItemMeta.html#setCanPlaceOn(java.util.Set)">setCanPlaceOn</a>, <a href="ItemMeta.html#setCustomModelData(java.lang.Integer)">setCustomModelData</a>, <a href="ItemMeta.html#setDestroyableKeys(java.util.Collection)">setDestroyableKeys</a>, <a href="ItemMeta.html#setDisplayName(java.lang.String)">setDisplayName</a>, <a href="ItemMeta.html#setDisplayNameComponent(net.md_5.bungee.api.chat.BaseComponent%5B%5D)">setDisplayNameComponent</a>, <a href="ItemMeta.html#setLocalizedName(java.lang.String)">setLocalizedName</a>, <a href="ItemMeta.html#setLore(java.util.List)">setLore</a>, <a href="ItemMeta.html#setLoreComponents(java.util.List)">setLoreComponents</a>, <a href="ItemMeta.html#setPlaceableKeys(java.ut
|
||
|
<div class="inherited-list">
|
||
|
<h3 id="methods-inherited-from-class-org.bukkit.persistence.PersistentDataHolder">Methods inherited from interface org.bukkit.persistence.<a href="../../persistence/PersistentDataHolder.html" title="interface in org.bukkit.persistence">PersistentDataHolder</a></h3>
|
||
|
<code><a href="../../persistence/PersistentDataHolder.html#getPersistentDataContainer()">getPersistentDataContainer</a></code></div>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="details">
|
||
|
<ul class="details-list">
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<li>
|
||
|
<section class="method-details" id="method-detail">
|
||
|
<h2>Method Details</h2>
|
||
|
<ul class="member-list">
|
||
|
<li>
|
||
|
<section class="detail" id="addEffect(org.bukkit.FireworkEffect)">
|
||
|
<h3>addEffect</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">addEffect</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a> effect)</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">Add another effect to this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>effect</code> - The firework effect to add</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 effect is null</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="addEffects(org.bukkit.FireworkEffect...)">
|
||
|
<h3>addEffects</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">addEffects</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>... effects)</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">Add several effects to this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>effects</code> - The firework effects to add</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 effects is null</dd>
|
||
|
<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 effect is null (may be thrown
|
||
|
after changes have occurred)</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="addEffects(java.lang.Iterable)">
|
||
|
<h3>addEffects</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">addEffects</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/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/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>> effects)</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">Add several firework effects to this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>effects</code> - An iterable object whose iterator yields the desired
|
||
|
firework effects</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 effects is null</dd>
|
||
|
<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 effect is null (may be thrown
|
||
|
after changes have occurred)</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getEffects()">
|
||
|
<h3>getEffects</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a>></span> <span class="element-name">getEffects</span>()</div>
|
||
|
<div class="block">Get the effects in this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>An immutable list of the firework effects</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getEffectsSize()">
|
||
|
<h3>getEffectsSize</h3>
|
||
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getEffectsSize</span>()</div>
|
||
|
<div class="block">Get the number of effects in this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>The number of effects</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="removeEffect(int)">
|
||
|
<h3>removeEffect</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeEffect</span><wbr><span class="parameters">(int index)</span>
|
||
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></span></div>
|
||
|
<div class="block">Remove an effect from this firework.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>index</code> - The index of the effect to remove</dd>
|
||
|
<dt>Throws:</dt>
|
||
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - If index < 0 or index > <a href="#getEffectsSize()"><code>getEffectsSize()</code></a></dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="clearEffects()">
|
||
|
<h3>clearEffects</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">clearEffects</span>()</div>
|
||
|
<div class="block">Remove all effects from this firework.</div>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="hasEffects()">
|
||
|
<h3>hasEffects</h3>
|
||
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasEffects</span>()</div>
|
||
|
<div class="block">Get whether this firework has any effects.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>true if it has effects, false if there are no effects</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getPower()">
|
||
|
<h3>getPower</h3>
|
||
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getPower</span>()</div>
|
||
|
<div class="block">Gets the approximate height the firework will fly.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>approximate flight height of the firework.</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="setPower(int)">
|
||
|
<h3>setPower</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setPower</span><wbr><span class="parameters">(int power)</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">Sets the approximate power of the firework. Each level of power is half
|
||
|
a second of flight time.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>power</code> - the power of the firework, from 0-128</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 height<0 or height>128</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/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="FireworkMeta.html" title="interface in org.bukkit.inventory.meta">FireworkMeta</a></span> <span class="element-name">clone</span>()</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Specified by:</dt>
|
||
|
<dd><code><a href="ItemMeta.html#clone()">clone</a></code> in interface <code><a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></code></dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
</main>
|
||
|
</div>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|