<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (12.0.1) on Fri Nov 01 13:30:56 CDT 2019 --> <title>ParticleEffect.ParticlePacket</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="dc.created" content="2019-11-01"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> <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> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ParticleEffect.ParticlePacket"; } } catch(err) { } //--> var data = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-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: </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="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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"> <!-- --> </a> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.massivecraft.factions.util.Particles</a></div> <h2 title="Class ParticleEffect.ParticlePacket" class="title">Class ParticleEffect.ParticlePacket</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Enclosing class:</dt> <dd><a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a></dd> </dl> <hr> <pre>public static final class <span class="typeNameLabel">ParticleEffect.ParticlePacket</span> extends java.lang.Object</pre> <div class="block">Represents a particle effect packet with all attributes which is used for sending packets to the players <p> This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>1.5</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <div class="memberSummary"> <table> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Constructor</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.massivecraft.factions.util.Particles.ParticleEffect,float,float,float,float,int,boolean,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleData)">ParticlePacket</a></span>​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, float offsetX, float offsetY, float offsetZ, float speed, int amount, boolean longDistance, <a href="ParticleEffect.ParticleData.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleData</a> data)</code></th> <td class="colLast"> <div class="block">Construct a new particle packet</div> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.massivecraft.factions.util.Particles.ParticleEffect,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleColor,boolean)">ParticlePacket</a></span>​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, <a href="ParticleEffect.ParticleColor.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleColor</a> color, boolean longDistance)</code></th> <td class="colLast"> <div class="block">Construct a new particle packet of a single colored particle</div> </td> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.massivecraft.factions.util.Particles.ParticleEffect,org.bukkit.util.Vector,float,boolean,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleData)">ParticlePacket</a></span>​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, org.bukkit.util.Vector direction, float speed, boolean longDistance, <a href="ParticleEffect.ParticleData.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleData</a> data)</code></th> <td class="colLast"> <div class="block">Construct a new particle packet of a single particle flying into a determined direction</div> </td> </tr> </tbody> </table> </div> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </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="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> <div id="memberSummary_tabpanel" role="tabpanel"> <table aria-labelledby="t0"> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor" id="i0"> <td class="colFirst"><code>static int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the version of your server (1.x)</div> </td> </tr> <tr class="rowColor" id="i1"> <td class="colFirst"><code>static void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th> <td class="colLast"> <div class="block">Initializes <code>packetConstructor</code>, <code>getHandle</code>, <code>playerConnection</code> and <code>sendPacket</code> and sets <code>initialized</code> to <code>true</code> if it succeeds <b>Note:</b> These fields only have to be initialized once, so it will return if <code>initialized</code> is already set to <code>true</code></div> </td> </tr> <tr class="altColor" id="i2"> <td class="colFirst"><code>static boolean</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInitialized()">isInitialized</a></span>()</code></th> <td class="colLast"> <div class="block">Determine if <code>packetConstructor</code>, <code>getHandle</code>, <code>playerConnection</code> and <code>sendPacket</code> are initialized</div> </td> </tr> <tr class="rowColor" id="i3"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTo(org.bukkit.Location,double)">sendTo</a></span>​(org.bukkit.Location center, double range)</code></th> <td class="colLast"> <div class="block">Sends the packet to all players in a certain range</div> </td> </tr> <tr class="altColor" id="i4"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTo(org.bukkit.Location,java.util.List)">sendTo</a></span>​(org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)</code></th> <td class="colLast"> <div class="block">Sends the packet to all players in the list</div> </td> </tr> <tr class="rowColor" id="i5"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTo(org.bukkit.Location,org.bukkit.entity.Player)">sendTo</a></span>​(org.bukkit.Location center, org.bukkit.entity.Player player)</code></th> <td class="colLast"> <div class="block">Sends the packet to a single player and caches it</div> </td> </tr> </tbody> </table> </div> </div> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(com.massivecraft.factions.util.Particles.ParticleEffect,float,float,float,float,int,boolean,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleData)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ParticlePacket</h4> <pre>public ParticlePacket​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, float offsetX, float offsetY, float offsetZ, float speed, int amount, boolean longDistance, <a href="ParticleEffect.ParticleData.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleData</a> data) throws java.lang.IllegalArgumentException</pre> <div class="block">Construct a new particle packet</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>effect</code> - Particle effect</dd> <dd><code>offsetX</code> - Maximum distance particles can fly away from the center on the x-axis</dd> <dd><code>offsetY</code> - Maximum distance particles can fly away from the center on the y-axis</dd> <dd><code>offsetZ</code> - Maximum distance particles can fly away from the center on the z-axis</dd> <dd><code>speed</code> - Display speed of the particles</dd> <dd><code>amount</code> - Amount of particles</dd> <dd><code>longDistance</code> - Indicates whether the maximum distance is increased from 256 to 65536</dd> <dd><code>data</code> - Data of the effect</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - If the speed or amount is lower than 0</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="#initialize()"><code>initialize()</code></a></dd> </dl> </li> </ul> <a id="<init>(com.massivecraft.factions.util.Particles.ParticleEffect,org.bukkit.util.Vector,float,boolean,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleData)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ParticlePacket</h4> <pre>public ParticlePacket​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, org.bukkit.util.Vector direction, float speed, boolean longDistance, <a href="ParticleEffect.ParticleData.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleData</a> data) throws java.lang.IllegalArgumentException</pre> <div class="block">Construct a new particle packet of a single particle flying into a determined direction</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>effect</code> - Particle effect</dd> <dd><code>direction</code> - Direction of the particle</dd> <dd><code>speed</code> - Display speed of the particle</dd> <dd><code>longDistance</code> - Indicates whether the maximum distance is increased from 256 to 65536</dd> <dd><code>data</code> - Data of the effect</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - If the speed is lower than 0</dd> </dl> </li> </ul> <a id="<init>(com.massivecraft.factions.util.Particles.ParticleEffect,com.massivecraft.factions.util.Particles.ParticleEffect.ParticleColor,boolean)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ParticlePacket</h4> <pre>public ParticlePacket​(<a href="ParticleEffect.html" title="enum in com.massivecraft.factions.util.Particles">ParticleEffect</a> effect, <a href="ParticleEffect.ParticleColor.html" title="class in com.massivecraft.factions.util.Particles">ParticleEffect.ParticleColor</a> color, boolean longDistance)</pre> <div class="block">Construct a new particle packet of a single colored particle</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>effect</code> - Particle effect</dd> <dd><code>color</code> - Color of the particle</dd> <dd><code>longDistance</code> - Indicates whether the maximum distance is increased from 256 to 65536</dd> </dl> </li> </ul> </li> </ul> </section> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="initialize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>initialize</h4> <pre class="methodSignature">public static void initialize() throws com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.VersionIncompatibleException</pre> <div class="block">Initializes <code>packetConstructor</code>, <code>getHandle</code>, <code>playerConnection</code> and <code>sendPacket</code> and sets <code>initialized</code> to <code>true</code> if it succeeds <b>Note:</b> These fields only have to be initialized once, so it will return if <code>initialized</code> is already set to <code>true</code></div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.VersionIncompatibleException</code> - if your bukkit version is not supported by this library</dd> </dl> </li> </ul> <a id="getVersion()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getVersion</h4> <pre class="methodSignature">public static int getVersion()</pre> <div class="block">Returns the version of your server (1.x)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The version number</dd> </dl> </li> </ul> <a id="isInitialized()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isInitialized</h4> <pre class="methodSignature">public static boolean isInitialized()</pre> <div class="block">Determine if <code>packetConstructor</code>, <code>getHandle</code>, <code>playerConnection</code> and <code>sendPacket</code> are initialized</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Whether these fields are initialized or not</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="#initialize()"><code>initialize()</code></a></dd> </dl> </li> </ul> <a id="sendTo(org.bukkit.Location,org.bukkit.entity.Player)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sendTo</h4> <pre class="methodSignature">public void sendTo​(org.bukkit.Location center, org.bukkit.entity.Player player) throws com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.PacketInstantiationException, com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.PacketSendingException</pre> <div class="block">Sends the packet to a single player and caches it</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>center</code> - Center location of the effect</dd> <dd><code>player</code> - Receiver of the packet</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.PacketInstantiationException</code> - If instantion fails due to an unknown error</dd> <dd><code>com.massivecraft.factions.util.Particles.ParticleEffect.ParticlePacket.PacketSendingException</code> - If sending fails due to an unknown error</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><code>initializePacket(Location)</code></dd> </dl> </li> </ul> <a id="sendTo(org.bukkit.Location,java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sendTo</h4> <pre class="methodSignature">public void sendTo​(org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) throws java.lang.IllegalArgumentException</pre> <div class="block">Sends the packet to all players in the list</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>center</code> - Center location of the effect</dd> <dd><code>players</code> - Receivers of the packet</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - If the player list is empty</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="#sendTo(org.bukkit.Location,org.bukkit.entity.Player)"><code>sendTo(Location center, Player player)</code></a></dd> </dl> </li> </ul> <a id="sendTo(org.bukkit.Location,double)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>sendTo</h4> <pre class="methodSignature">public void sendTo​(org.bukkit.Location center, double range) throws java.lang.IllegalArgumentException</pre> <div class="block">Sends the packet to all players in a certain range</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>center</code> - Center location of the effect</dd> <dd><code>range</code> - Range in which players will receive the packet (Maximum range for particles is usually 16, but it can differ for some types)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - If the range is lower than 1</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="#sendTo(org.bukkit.Location,org.bukkit.entity.Player)"><code>sendTo(Location center, Player player)</code></a></dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-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: </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="subNavList"> <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> <a id="skip.navbar.bottom"> <!-- --> </a> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>