ViaAPI (viaversion-api 4.10.1-SNAPSHOT API)

Type Parameters:

T - player type for the specific platform
```
public interface ViaAPI<T>
```
General api point. For more specialized api methods, see Via.getManager().

See Also:

ViaManager, ProtocolManager, ConnectionManager, ViaPlatform

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default int`	`apiVersion()` Returns an internally based API version incremented with meaningful API changes.
`@Nullable UserConnection`	`getConnection(java.util.UUID uuid)` Returns the Via injected UserConnection if present.
`java.util.SortedSet<ProtocolVersion>`	`getFullSupportedProtocolVersions()` Returns the supported protocol versions, including blocked protocols.
`default java.util.SortedSet<java.lang.Integer>`	`getFullSupportedVersions()` Deprecated.
`ProtocolVersion`	`getPlayerProtocolVersion(T player)` Returns the protocol version of a player.
`ProtocolVersion`	`getPlayerProtocolVersion(java.util.UUID uuid)` Returns the protocol version of a player.
`default int`	`getPlayerVersion(T player)` Returns the protocol version of a player.
`default int`	`getPlayerVersion(java.util.UUID uuid)` Returns the protocol version of a player.
`ServerProtocolVersion`	`getServerVersion()` Returns the server's protocol version info.
`java.util.SortedSet<ProtocolVersion>`	`getSupportedProtocolVersions()` Returns the supported protocol versions.
`default java.util.SortedSet<java.lang.Integer>`	`getSupportedVersions()` Deprecated.
`java.lang.String`	`getVersion()` Returns the version of the plugin.
`boolean`	`isInjected(java.util.UUID uuid)` Returns whether Via injected into this player connection.
`LegacyViaAPI<T>`	`legacyAPI()` Returns legacy api only applicable on/to legacy versions.
`default int`	`majorVersion()` Returns the major version matching `getVersion()`.
`void`	`sendRawPacket(T player, io.netty.buffer.ByteBuf packet)` Sends a raw packet to the player.
`void`	`sendRawPacket(java.util.UUID uuid, io.netty.buffer.ByteBuf packet)` Sends a raw packet to the player.

- Method Detail
  - majorVersion
```
default int majorVersion()
```
    Returns the major version matching getVersion(). It is highly advised to check against the major version and to disable/not initiate any hooks into ViaVersion if given and expected versions do not match.
    
    Returns:
    
    major plugin version
    
    Since:
    
    4.0.2
  - apiVersion
```
default int apiVersion()
```
    Returns an internally based API version incremented with meaningful API changes. This includes breaking changes to existing API and larger additions.
    
    Returns:
    
    API version incremented with meaningful API changes
  - getServerVersion
```
ServerProtocolVersion getServerVersion()
```
    Returns the server's protocol version info.
    
    Returns:
    
    the server's protocol version info
  - getPlayerVersion
```
default int getPlayerVersion(T player)
```
    Returns the protocol version of a player. This will also retrieve the version from ProtocolSupport if it's being used.
    
    Parameters:
    
    player - the platform's player object, e.g. Bukkit this is Player
    
    Returns:
    
    protocol version, for example (47=1.8-1.8.8, 107=1.9, 108=1.9.1), or -1 if no longer connected
  - getPlayerProtocolVersion
```
ProtocolVersion getPlayerProtocolVersion(T player)
```
    Returns the protocol version of a player. This will also retrieve the version from ProtocolSupport if it's being used.
    
    Parameters:
    
    player - the platform's player object, e.g. Bukkit this is Player
    
    Returns:
    
    the protocol version object (see ProtocolVersion), or ProtocolVersion.unknown if not connected
  - getPlayerVersion
```
default int getPlayerVersion(java.util.UUID uuid)
```
    Returns the protocol version of a player.
    
    Parameters:
    
    uuid - UUID of a player
    
    Returns:
    
    protocol version, for example (47=1.8-1.8.8, 107=1.9, 108=1.9.1), or -1 if not connected
  - getPlayerProtocolVersion
```
ProtocolVersion getPlayerProtocolVersion(java.util.UUID uuid)
```
    Returns the protocol version of a player. This will also retrieve the version from ProtocolSupport if it's being used.
    
    Parameters:
    
    uuid - UUID of a player
    
    Returns:
    
    the protocol version object (see ProtocolVersion), or ProtocolVersion.unknown if not connected
  - isInjected
```
boolean isInjected(java.util.UUID uuid)
```
    Returns whether Via injected into this player connection.
    
    Parameters:
    
    uuid - uuid of the player
    
    Returns:
    
    whether Via has a cached a UserConnection for this player
  - getConnection
```
@Nullable UserConnection getConnection(java.util.UUID uuid)
```
    Returns the Via injected UserConnection if present.
    
    Parameters:
    
    uuid - uuid of the player
    
    Returns:
    
    user connection if present
  - getVersion
```
java.lang.String getVersion()
```
    Returns the version of the plugin.
    
    Returns:
    
    plugin version
  - sendRawPacket
```
void sendRawPacket(T player,
                   io.netty.buffer.ByteBuf packet)
```
    Sends a raw packet to the player.
    
    Parameters:
    
    player - the platform's player object, e.g. for Bukkit this is Player
    
    packet - the packet; you need a VarInt id, then the packet contents
    
    Throws:
    
    java.lang.IllegalArgumentException - if the player is not injected by Via
  - sendRawPacket
```
void sendRawPacket(java.util.UUID uuid,
                   io.netty.buffer.ByteBuf packet)
```
    Sends a raw packet to the player.
    
    Parameters:
    
    uuid - the uuid from the player to send packet
    
    packet - the packet; you need a VarInt id, then the packet contents
    
    Throws:
    
    java.lang.IllegalArgumentException - if the player is not injected by Via
  - getSupportedVersions
```
@Deprecated
default java.util.SortedSet<java.lang.Integer> getSupportedVersions()
```
    Deprecated.
  - getFullSupportedVersions
```
@Deprecated
default java.util.SortedSet<java.lang.Integer> getFullSupportedVersions()
```
    Deprecated.
  - getSupportedProtocolVersions
```
java.util.SortedSet<ProtocolVersion> getSupportedProtocolVersions()
```
    Returns the supported protocol versions. This method removes any blocked protocol versions.
    
    Returns:
    
    a sorted set of protocol versions
    
    See Also:
    
    for a full list
  - getFullSupportedProtocolVersions
```
java.util.SortedSet<ProtocolVersion> getFullSupportedProtocolVersions()
```
    Returns the supported protocol versions, including blocked protocols.
    
    Returns:
    
    a sorted set of protocol versions
  - legacyAPI
```
LegacyViaAPI<T> legacyAPI()
```
    Returns legacy api only applicable on/to legacy versions.
    These methods are safe to use and are unlikely to be removed, but it is important to be aware of their limited use.
    
    Returns:
    
    legacy api only applicable on/to legacy versions

Interface ViaAPI<T>

Method Summary

Method Detail

majorVersion

apiVersion

getServerVersion

getPlayerVersion

getPlayerProtocolVersion

getPlayerVersion

getPlayerProtocolVersion

isInjected

getConnection

getVersion

sendRawPacket

sendRawPacket

getSupportedVersions

getFullSupportedVersions

getSupportedProtocolVersions

getFullSupportedProtocolVersions

legacyAPI