Improve documentation.
Dieser Commit ist enthalten in:
Ursprung
28b213a419
Commit
75eac1c9aa
@ -42,7 +42,7 @@ import com.comphenix.protocol.injector.PacketFilterManager.PlayerInjectHooks;
|
||||
import com.comphenix.protocol.injector.player.TemporaryPlayerFactory.InjectContainer;
|
||||
|
||||
/**
|
||||
* Injection method that overrides the NetworkHandler itself, and it's queue-method.
|
||||
* Injection method that overrides the NetworkHandler itself, and its queue-method.
|
||||
*
|
||||
* @author Kristian
|
||||
*/
|
||||
@ -59,6 +59,17 @@ public class NetworkObjectInjector extends PlayerInjector {
|
||||
// Temporary player factory
|
||||
private static volatile TemporaryPlayerFactory tempPlayerFactory;
|
||||
|
||||
/**
|
||||
* Create a new network object injector.
|
||||
* <p>
|
||||
* Note: This class is intended to be internal. Do not use.
|
||||
* @param classLoader - the class loader.
|
||||
* @param reporter - the error reporter.
|
||||
* @param player - the player Bukkit entity.
|
||||
* @param invoker - the packet invoker.
|
||||
* @param sendingFilters - list of permitted packet IDs.
|
||||
* @throws IllegalAccessException If reflection failed.
|
||||
*/
|
||||
public NetworkObjectInjector(ClassLoader classLoader, ErrorReporter reporter, Player player,
|
||||
ListenerInvoker invoker, IntegerSet sendingFilters) throws IllegalAccessException {
|
||||
super(reporter, player, invoker);
|
||||
|
@ -141,6 +141,11 @@ public class SpigotPacketInjector implements SpigotPacketListener {
|
||||
this.reveivedFilters = new IntegerSet(Packets.MAXIMUM_PACKET_ID + 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Register the Spigot packet injector.
|
||||
* @param plugin - the parent plugin.
|
||||
* @return TRUE if we registered the plugin, FALSE otherwise.
|
||||
*/
|
||||
public boolean register(Plugin plugin) {
|
||||
if (hasRegistered())
|
||||
return false;
|
||||
@ -225,14 +230,26 @@ public class SpigotPacketInjector implements SpigotPacketListener {
|
||||
isMatch(MethodInfo.fromMethod(method), null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the Spigot packet listener has been registered.
|
||||
* @return TRUE if it has, FALSE otherwise.
|
||||
*/
|
||||
public boolean hasRegistered() {
|
||||
return dynamicListener != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the dummy player injection handler.
|
||||
* @return Dummy player injection handler.
|
||||
*/
|
||||
public PlayerInjectionHandler getPlayerHandler() {
|
||||
return new DummyPlayerHandler(this, queuedFilters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the dummy packet injection handler.
|
||||
* @return Dummy packet injection handler.
|
||||
*/
|
||||
public PacketInjector getPacketInjector() {
|
||||
return new DummyPacketInjector(this, reveivedFilters);
|
||||
}
|
||||
|
@ -13,21 +13,21 @@ interface SpigotPacketListener {
|
||||
* The returned packet will be the packet passed on for handling, or in the case of
|
||||
* null being returned, not handled at all.
|
||||
*
|
||||
* @param networkManager the NetworkManager receiving the packet
|
||||
* @param connection the connection which will handle the packet
|
||||
* @param packet the received packet
|
||||
* @param networkManager - the NetworkManager receiving the packet
|
||||
* @param connection - the connection which will handle the packet
|
||||
* @param packet - the received packet
|
||||
* @return the packet to be handled, or null to cancel
|
||||
*/
|
||||
public Object packetReceived(Object networkManager, Object connection, Object packet);
|
||||
|
||||
/**
|
||||
* Called when a packet is queued to be sent.The returned packet will be
|
||||
* the packet sent. In the case of null being returned, the packet will not
|
||||
* be sent.
|
||||
*
|
||||
* @param networkManager the NetworkManager which will send the packet
|
||||
* @param connection the connection which queued the packet
|
||||
* @param packet the queue packet
|
||||
* Called when a packet is queued to be sent.
|
||||
* <p>
|
||||
* The returned packet will be the packet sent. In the case of null being returned,
|
||||
* the packet will not be sent.
|
||||
* @param networkManager - the NetworkManager which will send the packet
|
||||
* @param connection - the connection which queued the packet
|
||||
* @param packet - the queue packet
|
||||
* @return the packet to be sent, or null if the packet will not be sent.
|
||||
*/
|
||||
public Object packetQueued(Object networkManager, Object connection, Object packet);
|
||||
|
14
ProtocolLib/src/main/java/com/comphenix/protocol/package-info.java
Normale Datei
14
ProtocolLib/src/main/java/com/comphenix/protocol/package-info.java
Normale Datei
@ -0,0 +1,14 @@
|
||||
/**
|
||||
* Contains classes for retrieving the main {@link ProtocolMananger} object.
|
||||
* <p>
|
||||
* This allows plugins to reliably and easily read and modify the packet stream of any CraftBukkit-derivative
|
||||
* (or specifically compatible) Minecraft-server.
|
||||
* <p>
|
||||
* This manager can be retrieved throught a static method in {@link ProtocolLibrary}:
|
||||
* <pre>
|
||||
* {@code
|
||||
* ProtocolManager manager = ProtocolLibrary.getProtocolManager();
|
||||
* }
|
||||
* </pre>
|
||||
*/
|
||||
package com.comphenix.protocol;
|
In neuem Issue referenzieren
Einen Benutzer sperren