Package xyz.gmitch215.socketmc.spigot

Class SocketPlayer

java.lang.Object

xyz.gmitch215.socketmc.spigot.SocketPlayer

public final class SocketPlayer
extends Object

Represents a player connected to the server with SocketMC installed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PACKET_INJECTOR_ID	The ID of the packet injector.

Constructor Summary

Constructors

Constructor	Description
SocketPlayer(@NotNull Player p)	Creates a new SocketPlayer instance.

Method Summary

Modifier and Type	Method	Description
@NotNull Channel	getChannel()	Gets the netty channel connecting the player to the server.
@NotNull Player	getPlayer()	Gets the player associated with this SocketPlayer instance.
@NotNull SocketRetriever	getRetriever()	Gets the retriever for this SocketPlayer.
void	ping()	Sends a Instruction.PING instruction.
static void	registerEvents(@NotNull Player p)	Registers the packet injector for the player.
void	sendInstruction(@NotNull Instruction i, @NotNull Plugin plugin)	Sends an instruction to the player.
void	sendInstruction(@NotNull Instruction i, @NotNull SocketPlugin plugin)	Sends an instruction to the player.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PACKET_INJECTOR_ID

public static final String PACKET_INJECTOR_ID

The ID of the packet injector.

See Also:

• Constant Field Values

Constructor Details

SocketPlayer

public SocketPlayer(@NotNull
 @NotNull Player p)
             throws SocketMCNotInstalledException

Creates a new SocketPlayer instance.

Parameters:

p - The player to create the instance for.

Throws:

SocketMCNotInstalledException - if the player does not have SocketMC installed

Method Details

getPlayer

@NotNull
public @NotNull Player getPlayer()

Gets the player associated with this SocketPlayer instance.

Returns:

Player

getChannel

@NotNull
public @NotNull Channel getChannel()

Gets the netty channel connecting the player to the server.

Returns:

Network Channel

ping

public void ping()

Sends a Instruction.PING instruction.

sendInstruction

public void sendInstruction(@NotNull
 @NotNull Instruction i,
 @NotNull
 @NotNull Plugin plugin)
                     throws SocketMCNotInstalledException

Sends an instruction to the player.

Parameters:

i - The instruction to send.

plugin - The plugin sending the instruction.

Throws:

SocketMCNotInstalledException - if the player does not have SocketMC installed

sendInstruction

public void sendInstruction(@NotNull
 @NotNull Instruction i,
 @NotNull
 @NotNull SocketPlugin plugin)
                     throws SocketMCNotInstalledException,
FailedInstructionException

Sends an instruction to the player.

Parameters:

i - The instruction to send.

plugin - The plugin sending the instruction.

Throws:

SocketMCNotInstalledException - if the player does not have SocketMC installed

FailedInstructionException - if the instruction fails to send

See Also:

• SocketPlugin

getRetriever

@NotNull
public @NotNull SocketRetriever getRetriever()

Gets the retriever for this SocketPlayer.

Returns:

Socket Retriever

registerEvents

public static void registerEvents(@NotNull
 @NotNull Player p)

Registers the packet injector for the player. Please note that a Instruction.PING instruction must be sent at least once in order for the client to start sending events.

Parameters:

p - The player to register the events for.