Saber-Factions/javadoc/com/massivecraft/factions/util/Particles/ParticleEffect.ParticleProperty.html

414 lines
15 KiB
HTML
Raw Permalink Normal View History

<!DOCTYPE HTML>
2018-08-29 07:09:18 +02:00
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (12.0.1) on Fri Nov 01 13:30:56 CDT 2019 -->
2018-08-29 07:09:18 +02:00
<title>ParticleEffect.ParticleProperty</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2019-11-01">
2018-08-29 07:09:18 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
2018-08-29 07:09:18 +02:00
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
2018-08-29 07:09:18 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParticleEffect.ParticleProperty";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9};
2018-08-29 07:09:18 +02:00
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2018-08-29 07:09:18 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2018-08-29 07:09:18 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2018-08-29 07:09:18 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2018-08-29 07:09:18 +02:00
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
2018-08-29 07:09:18 +02:00
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2018-08-29 07:09:18 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2018-08-29 07:09:18 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.massivecraft.factions.util.Particles</a></div>
2018-08-29 07:09:18 +02:00
<h2 title="Enum ParticleEffect.ParticleProperty" class="title">Enum ParticleEffect.ParticleProperty</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>&gt;</li>
2018-08-29 07:09:18 +02:00
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.util.Particles.ParticleEffect.ParticleProperty</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>&gt;</code>, <code>java.lang.constant.Constable</code></dd>
2018-08-29 07:09:18 +02:00
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a></dd>
2018-08-29 07:09:18 +02:00
</dl>
<hr>
<pre>public static enum <span class="typeNameLabel">ParticleEffect.ParticleProperty</span>
extends java.lang.Enum&lt;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>&gt;</pre>
2018-08-29 07:09:18 +02:00
<div class="block">Represents the property of a particle effect
This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions</div>
2018-08-29 07:09:18 +02:00
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Enum</h3>
<code>java.lang.Enum.EnumDesc&lt;E extends java.lang.Enum&lt;E&gt;&gt;</code></li>
</ul>
</li>
</ul>
</section>
2018-08-29 07:09:18 +02:00
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
2018-08-29 07:09:18 +02:00
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<div class="memberSummary">
<table>
2018-08-29 07:09:18 +02:00
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
2018-08-29 07:09:18 +02:00
</tr>
<tbody>
2018-08-29 07:09:18 +02:00
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#COLORABLE">COLORABLE</a></span></code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect uses the offsets as color values</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DIRECTIONAL">DIRECTIONAL</a></span></code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect uses the offsets as direction values</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#REQUIRES_DATA">REQUIRES_DATA</a></span></code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect requires block or item data to be displayed</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#REQUIRES_WATER">REQUIRES_WATER</a></span></code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect requires water to be displayed</div>
</td>
</tr>
</tbody>
2018-08-29 07:09:18 +02:00
</table>
</div>
2018-08-29 07:09:18 +02:00
</li>
</ul>
</section>
2018-08-29 07:09:18 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2018-08-29 07:09:18 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
2018-08-29 07:09:18 +02:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2018-08-29 07:09:18 +02:00
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>static <a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static <a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
2018-08-29 07:09:18 +02:00
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</tbody>
2018-08-29 07:09:18 +02:00
</table>
</div>
</div>
2018-08-29 07:09:18 +02:00
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
2018-08-29 07:09:18 +02:00
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2018-08-29 07:09:18 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
2018-08-29 07:09:18 +02:00
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="REQUIRES_WATER">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQUIRES_WATER</h4>
<pre>public static final&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a> REQUIRES_WATER</pre>
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect requires water to be displayed</div>
</li>
</ul>
<a id="REQUIRES_DATA">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQUIRES_DATA</h4>
<pre>public static final&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a> REQUIRES_DATA</pre>
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect requires block or item data to be displayed</div>
</li>
</ul>
<a id="DIRECTIONAL">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DIRECTIONAL</h4>
<pre>public static final&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a> DIRECTIONAL</pre>
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect uses the offsets as direction values</div>
</li>
</ul>
<a id="COLORABLE">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>COLORABLE</h4>
<pre>public static final&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a> COLORABLE</pre>
2018-08-29 07:09:18 +02:00
<div class="block">The particle effect uses the offsets as color values</div>
</li>
</ul>
</li>
</ul>
</section>
2018-08-29 07:09:18 +02:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2018-08-29 07:09:18 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>[]&nbsp;values()</pre>
2018-08-29 07:09:18 +02:00
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
2018-08-29 07:09:18 +02:00
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="ParticleEffect.ParticleProperty.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleProperty</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
2018-08-29 07:09:18 +02:00
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2018-08-29 07:09:18 +02:00
</li>
</ul>
</div>
</div>
</main>
2018-08-29 07:09:18 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2018-08-29 07:09:18 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2018-08-29 07:09:18 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2018-08-29 07:09:18 +02:00
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
2018-08-29 07:09:18 +02:00
<!-- -->
</a>
2018-08-29 07:09:18 +02:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2018-08-29 07:09:18 +02:00
</body>
</html>