GeyserApi (geyser-api 2.0.0-SNAPSHOT API)

All Superinterfaces:: GeyserApiBase

public interface GeyserApi extends GeyserApiBase

Represents the API used in Geyser.

Method Summary

Modifier and Type

Method

Description

@Nullable GeyserConnection

connectionByName(@NonNull String name)

@Nullable GeyserConnection

connectionByUuid(@NonNull UUID uuid)

@Nullable GeyserConnection

connectionByXuid(@NonNull String xuid)

@NonNull List<? extends GeyserConnection>

onlineConnections()

boolean

productionEnvironment()

Gets if this Geyser instance is running in an IDE.

void

reload()

Reloads the current Geyser instance.

void

shutdown()

Shuts down the current Geyser instance.

Methods inherited from interface org.geysermc.api.GeyserApiBase
majorApiVersion, minorApiVersion

Method Details
- shutdown
  
  void shutdown()
  
  Shuts down the current Geyser instance.
- reload
  
  void reload()
  
  Reloads the current Geyser instance.
- productionEnvironment
  
  boolean productionEnvironment()
  
  Gets if this Geyser instance is running in an IDE. This only needs to be used in cases where files expected to be in a jarfile are not present.
  
  Returns:
  
  true if the version number is not 'DEV'.
- connectionByUuid
  
  @Nullable GeyserConnection connectionByUuid(@NonNull UUID uuid)
  
  Specified by:
  
  connectionByUuid in interface GeyserApiBase
- connectionByXuid
  
  @Nullable GeyserConnection connectionByXuid(@NonNull String xuid)
  
  Specified by:
  
  connectionByXuid in interface GeyserApiBase
- connectionByName
  
  @Nullable GeyserConnection connectionByName(@NonNull String name)
  
  Specified by:
  
  connectionByName in interface GeyserApiBase
- onlineConnections
  
  @NonNull List<? extends GeyserConnection> onlineConnections()
  
  Specified by:
  
  onlineConnections in interface GeyserApiBase