package
0.39.3
Repository: https://github.com/minekube/gate.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BroadcastMessage broadcasts a message to all given sinks (e.g.
BroadcastPluginMessage sends the plugin message to all players on the server.
New returns a new Proxy ready to start.
NewGameProfileRequestEvent creates a new GameProfileRequestEvent.
No description provided by the author
PlayersToSlice returns a slice of all players.
RegisteredServerEqual returns true if RegisteredServer a and b are equal.
ServerInfoEqual returns true if ServerInfo a and b are equal.
WithMessageSender modifies the sender identity of the chat message.
WithMessageType modifies chat message type.

# Constants

AcceptedResourcePackResponseStatus indicates the player has accepted the resource pack and is now downloading it.
PreLoginResult values.
AlreadyConnectedConnectionStatus indicates that the player is already connected to this server.
No description provided by the author
No description provided by the author
No description provided by the author
CanceledConnectionStatus indicates that a plugin has cancelled this connection.
ChatMessageType is a standard chat message and lets the chat message appear in the client's HUD.
No description provided by the author
DeclinedResourcePackResponseStatus indicates the player declined to download the resource pack.
PreLoginResult values.
DiscardedResourcePackResponseStatus indicates the resource pack was discarded.
DownloadedResourcePackResponseStatus indicates the player has downloaded the resource pack.
No description provided by the author
FailedDownloadResourcePackResponseStatus indicates the player could not download the resource pack.
FailedToReloadResourcePackResponseStatus indicates the player failed to reload the resource pack.
PreLoginResult values.
PreLoginResult values.
GameInfoMessageType lets the chat message appear above the player's main HUD.
InProgressConnectionStatus indicates that a connection is already in progress.
InvalidURLResourcePackResponseStatus indicates the URL of the resource pack failed to load.
No description provided by the author
ServerDisconnectedConnectionStatus indicates that the server disconnected the player.
SuccessConnectionStatus indicates that the player was successfully connected to the server.
No description provided by the author
SuccessfulResourcePackResponseStatus indicates the resource pack was applied successfully.
SystemMessageType is a system chat message.

# Variables

No description provided by the author
ErrProxyAlreadyRun is returned by Proxy.Run if the proxy instance was already run.
ErrServerAlreadyExists indicates that a server is already registered in ServerRegistrar.
ErrServerOnlineMode indicates error in a ConnectionRequest when the backend server is in online mode.
No description provided by the author
No description provided by the author
Plugins is used to register plugins with the proxy.

# Structs

ChatState tracks the last Secure Chat state that we received from the client.
CommandExecuteEvent is fired when someone wants to execute a command.
ConnectionEvent is fired when a client connects with the proxy.
ConnectionHandshakeEvent is fired when a handshake is established between a client and the proxy.
No description provided by the author
DisconnectPlayerKickResult is a ServerKickResult and tells the proxy to disconnect the player with the specified reason.
GameProfileRequestEvent is fired after the PreLoginEvent in order to set up the game profile for the user.
Fired when a player is kicked from a server.
No description provided by the author
NotifyKickResult is ServerKickResult and notifies the player with the specified message but does nothing else.
Options are the options for a new Java edition Proxy.
PermissionsSetupEvent is fired once a permission.Subject's permissions are being initialized.
PingEvent is fired when a request for server information is sent by a remote client, or when the server sends the MOTD and favicon to the client after a successful login.
PlayerAvailableCommandsEvent allows plugins to modify the packet indicating commands available on the server to a Minecraft 1.13+ client.
PlayerChannelRegisterEvent is fired when a client Player sends a plugin message through the register channel.
PlayerChatEvent is fired when a player sends a chat message.
PlayerChooseInitialServerEvent is fired when a player has finished the login process, and we need to choose the first server to connect to.
PlayerClientBrandEvent is fired when a Player sends the `minecraft:brand` plugin message.
PlayerModInfoEvent is fired when a Forge client sends its mods to the proxy while connecting to a server.
No description provided by the author
Plugin provides the ability to extend Gate with external code.
PluginMessageEvent is fired when a plugin message is sent to the proxy, either from a player or a server backend server.
No description provided by the author
PreLoginEvent is fired when a player has initiated a connection with the proxy but before the proxy authenticates the player with Mojang or before the player's proxy connection is fully established (for offline mode).
PreShutdownEvent is fired before the proxy begins to shut down by stopping to accept new connections and disconnect all players.
PreTransferEvent is fired before a player is transferred to another host, either by the backend server or by a plugin using the Player.TransferTo method.
Proxy is Gate's Java edition Minecraft proxy.
ReadyEvent is fired once the proxy was successfully initialized and is ready to serve connections.
RedirectPlayerKickResult is a ServerKickResult and tells the proxy to redirect the player to another server.
ServerConnectedEvent is fired before the player completely transitions to the target server and the connection to the previous server has been de-established.
ServerLoginPluginMessageEvent is fired when a server sends a login plugin message to the proxy.
No description provided by the author
ServerPostConnectEvent is fired after the player has connected to a server.
ServerPreConnectEvent is fired before the player connects to a server.
ServerResourcePackSendEvent is fired when the downstream server tries to send a player a ResourcePack packet.
ShutdownEvent is fired by the proxy after the proxy has stopped accepting connections and PreShutdownEvent, but before the proxy process exits.
TabCompleteEvent is fired after a tab complete response is sent by the remote server, for clients on1.12.2 and below.

# Interfaces

ConnectionEventConn tracks whether Close was called on the connection.
ConnectionRequest can send a connection request to another server on the proxy.
ConnectionResult is the result of a ConnectionRequest.
GameProfileProvider provides the GameProfile for a player connection.
HandshakeAddresser provides the ServerAddress sent with the packet.Handshake when a player joins the server implementing this interface.
Inbound is an incoming connection to the proxy.
No description provided by the author
No description provided by the author
MessageSink is a message sink.
Player is a connected Minecraft player.
Players is a list of players safe for concurrent use.
RegisteredServer is a backend server that has been registered with the proxy.
ServerConnection is a connection to a backend server from the proxy for a client.
ServerDialer provides the server connection for a joining player.
ServerInfo is the info of a backend server.
ServerKickResult is the result of a KickedFromServerEvent and is implemented by # DisconnectPlayerKickResult # RedirectPlayerKickResult NotifyKickResult.
ServerRegistrar is used to register servers.
ServerRegistry is used to retrieve registered servers that players can connect to.

# Type aliases

ConnectionStatus is the status for a ConnectionResult.
No description provided by the author
MessageType is a chat message type.
PlayerResourcePackStatusEvent is fired when the status of a resource pack sent to the player by the server is changed.
PreLoginResult is the result of a PreLoginEvent.
ResourcePackInfo is resource-pack options for Player.SendResourcePack.
ResourcePackOrigin represents the origin of the resource-pack.
ResourcePackResponseStatus represents the possible statuses for the resource pack.