mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-12-12 12:26:49 +01:00
535 lines
24 KiB
HTML
535 lines
24 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_07) on Thu Oct 11 02:58:30 CEST 2012 -->
|
|
<title>PacketEvent</title>
|
|
<meta name="date" content="2012-10-11">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="PacketEvent";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/PacketEvent.html">Use</a></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">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/events/PacketEvent.html" target="_top">Frames</a></li>
|
|
<li><a href="PacketEvent.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#fields_inherited_from_class_java.util.EventObject">Field</a> | </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>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">com.comphenix.protocol.events</div>
|
|
<h2 title="Class PacketEvent" class="title">Class PacketEvent</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>java.util.EventObject</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.events.PacketEvent</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>java.io.Serializable, org.bukkit.event.Cancellable</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">PacketEvent</span>
|
|
extends java.util.EventObject
|
|
implements org.bukkit.event.Cancellable</pre>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.comphenix.protocol.events.PacketEvent">Serialized Form</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields_inherited_from_class_java.util.EventObject">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class java.util.EventObject</h3>
|
|
<code>source</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#PacketEvent(java.lang.Object)">PacketEvent</a></strong>(java.lang.Object source)</code>
|
|
<div class="block">Use the static constructors to create instances of this event.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#fromClient(java.lang.Object, com.comphenix.protocol.events.PacketContainer, org.bukkit.entity.Player)">fromClient</a></strong>(java.lang.Object source,
|
|
<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet,
|
|
org.bukkit.entity.Player client)</code>
|
|
<div class="block">Creates an event representing a client packet transmission.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#fromServer(java.lang.Object, com.comphenix.protocol.events.PacketContainer, org.bukkit.entity.Player)">fromServer</a></strong>(java.lang.Object source,
|
|
<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet,
|
|
org.bukkit.entity.Player recipient)</code>
|
|
<div class="block">Creates an event representing a server packet transmission.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#fromSynchronous(com.comphenix.protocol.events.PacketEvent, com.comphenix.protocol.async.AsyncMarker)">fromSynchronous</a></strong>(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a> event,
|
|
<a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a> marker)</code>
|
|
<div class="block">Create an asynchronous packet event from a synchronous event and a async marker.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#getAsyncMarker()">getAsyncMarker</a></strong>()</code>
|
|
<div class="block">Retrieve the asynchronous marker.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#getPacket()">getPacket</a></strong>()</code>
|
|
<div class="block">Retrieves the packet that will be sent to the player.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#getPacketID()">getPacketID</a></strong>()</code>
|
|
<div class="block">Retrieves the packet ID.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>org.bukkit.entity.Player</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#getPlayer()">getPlayer</a></strong>()</code>
|
|
<div class="block">Retrieves the player that has sent the packet or is recieving it.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#isAsynchronous()">isAsynchronous</a></strong>()</code>
|
|
<div class="block">Determine if the packet event has been executed asynchronously or not.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#isCancelled()">isCancelled</a></strong>()</code>
|
|
<div class="block">Retrieves whether or not the packet should be cancelled.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#isServerPacket()">isServerPacket</a></strong>()</code>
|
|
<div class="block">Whether or not this packet was created by the server.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#setAsyncMarker(com.comphenix.protocol.async.AsyncMarker)">setAsyncMarker</a></strong>(<a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a> asyncMarker)</code>
|
|
<div class="block">Set the asynchronous marker.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#setCancelled(boolean)">setCancelled</a></strong>(boolean cancel)</code>
|
|
<div class="block">Sets whether or not the packet should be cancelled.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketEvent.html#setPacket(com.comphenix.protocol.events.PacketContainer)">setPacket</a></strong>(<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet)</code>
|
|
<div class="block">Replace the packet that will be sent to the player.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.util.EventObject">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.util.EventObject</h3>
|
|
<code>getSource, toString</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="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, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="PacketEvent(java.lang.Object)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>PacketEvent</h4>
|
|
<pre>public PacketEvent(java.lang.Object source)</pre>
|
|
<div class="block">Use the static constructors to create instances of this event.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - - the event source.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="fromClient(java.lang.Object, com.comphenix.protocol.events.PacketContainer, org.bukkit.entity.Player)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fromClient</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a> fromClient(java.lang.Object source,
|
|
<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet,
|
|
org.bukkit.entity.Player client)</pre>
|
|
<div class="block">Creates an event representing a client packet transmission.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - - the event source.</dd><dd><code>packet</code> - - the packet.</dd><dd><code>client</code> - - the client that sent the packet.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The event.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fromServer(java.lang.Object, com.comphenix.protocol.events.PacketContainer, org.bukkit.entity.Player)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fromServer</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a> fromServer(java.lang.Object source,
|
|
<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet,
|
|
org.bukkit.entity.Player recipient)</pre>
|
|
<div class="block">Creates an event representing a server packet transmission.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - - the event source.</dd><dd><code>packet</code> - - the packet.</dd><dd><code>recipient</code> - - the client that will receieve the packet.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The event.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fromSynchronous(com.comphenix.protocol.events.PacketEvent, com.comphenix.protocol.async.AsyncMarker)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fromSynchronous</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a> fromSynchronous(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a> event,
|
|
<a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a> marker)</pre>
|
|
<div class="block">Create an asynchronous packet event from a synchronous event and a async marker.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - - the original synchronous event.</dd><dd><code>marker</code> - - the asynchronous marker.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The new packet event.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPacket()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPacket</h4>
|
|
<pre>public <a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> getPacket()</pre>
|
|
<div class="block">Retrieves the packet that will be sent to the player.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Packet to send to the player.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPacket(com.comphenix.protocol.events.PacketContainer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPacket</h4>
|
|
<pre>public void setPacket(<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a> packet)</pre>
|
|
<div class="block">Replace the packet that will be sent to the player.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>packet</code> - - the packet that will be sent instead.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPacketID()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPacketID</h4>
|
|
<pre>public int getPacketID()</pre>
|
|
<div class="block">Retrieves the packet ID.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The current packet ID.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isCancelled()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isCancelled</h4>
|
|
<pre>public boolean isCancelled()</pre>
|
|
<div class="block">Retrieves whether or not the packet should be cancelled.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>isCancelled</code> in interface <code>org.bukkit.event.Cancellable</code></dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>TRUE if it should be cancelled, FALSE otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCancelled(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCancelled</h4>
|
|
<pre>public void setCancelled(boolean cancel)</pre>
|
|
<div class="block">Sets whether or not the packet should be cancelled.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>setCancelled</code> in interface <code>org.bukkit.event.Cancellable</code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>cancel</code> - - TRUE if it should be cancelled, FALSE otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPlayer()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPlayer</h4>
|
|
<pre>public org.bukkit.entity.Player getPlayer()</pre>
|
|
<div class="block">Retrieves the player that has sent the packet or is recieving it.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The player associated with this event.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isServerPacket()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isServerPacket</h4>
|
|
<pre>public boolean isServerPacket()</pre>
|
|
<div class="block">Whether or not this packet was created by the server.
|
|
<p>
|
|
Most listeners can deduce this by noting which listener method was invoked.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>TRUE if the packet was created by the server, FALSE if it was created by a client.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAsyncMarker()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAsyncMarker</h4>
|
|
<pre>public <a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a> getAsyncMarker()</pre>
|
|
<div class="block">Retrieve the asynchronous marker.
|
|
<p>
|
|
If the packet is synchronous, this marker will be used to schedule an asynchronous event. In the following
|
|
asynchronous event, the marker is used to correctly pass the packet around to the different threads.
|
|
<p>
|
|
Note that if there are no asynchronous events that can receive this packet, the marker is NULL.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The current asynchronous marker, or NULL.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setAsyncMarker(com.comphenix.protocol.async.AsyncMarker)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAsyncMarker</h4>
|
|
<pre>public void setAsyncMarker(<a href="../../../../com/comphenix/protocol/async/AsyncMarker.html" title="class in com.comphenix.protocol.async">AsyncMarker</a> asyncMarker)</pre>
|
|
<div class="block">Set the asynchronous marker.
|
|
<p>
|
|
If the marker is non-null at the end of an synchronous event processing, the packet will be scheduled
|
|
to be processed asynchronously with the given settings.
|
|
<p>
|
|
Note that if there are no asynchronous events that can receive this packet, the marker should be NULL.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>asyncMarker</code> - - the new asynchronous marker, or NULL.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - If the current event is asynchronous.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isAsynchronous()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>isAsynchronous</h4>
|
|
<pre>public boolean isAsynchronous()</pre>
|
|
<div class="block">Determine if the packet event has been executed asynchronously or not.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>TRUE if this packet event is asynchronous, FALSE otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/PacketEvent.html">Use</a></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">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/events/PacketEvent.html" target="_top">Frames</a></li>
|
|
<li><a href="PacketEvent.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#fields_inherited_from_class_java.util.EventObject">Field</a> | </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>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|