dev.id2r.api.common.plugin.bootstrap

Interface ID2RPluginBootstrap

public interface ID2RPluginBootstrap

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getDataDirectory() Gets the plugins main data storage directory
PluginLogger	getLogger() Logger adapter for all platforms
java.util.Collection<java.util.UUID>	getOnlinePlayers() Gets the UUIDs of the users online on the platform
Platform.Type	getPlatformType() Gets the platform type this instance is running on.
java.util.Optional<?>	getPlayer(java.util.UUID uuid) Get a player object
int	getPlayerCount() Gets the number of users online on the platform
java.util.Collection<java.lang.String>	getPlayerList() Gets the usernames of the users online on the platform
default com.google.common.collect.ImmutableSet<DynamicDependency>	getRequiredDependencies() Set of required dependencies for this plugin to run.
default java.io.InputStream	getResourceStream(java.lang.String path) Gets a bundled resource file from the jar
java.time.Instant	getStartupTime() Gets the time when the plugin first started in millis.
TaskFactory	getTaskFactory() Task adapter for platform
java.lang.String	getVersion() get plugin version
boolean	isPlayerOnline(java.util.UUID uniqueId) Checks if a user is online

Method Detail

getLogger

PluginLogger getLogger()

Logger adapter for all platforms

Returns:

plugin logger

getTaskFactory

TaskFactory getTaskFactory()

Task adapter for platform

Returns:

task adapter

getRequiredDependencies

default com.google.common.collect.ImmutableSet<DynamicDependency> getRequiredDependencies()

Set of required dependencies for this plugin to run.

Returns:

immutable set of required dependencies

getVersion

java.lang.String getVersion()

get plugin version

Returns:

version in string

getStartupTime

java.time.Instant getStartupTime()

Gets the time when the plugin first started in millis.

Returns:

enable time

getPlatformType

Platform.Type getPlatformType()

Gets the platform type this instance is running on.

Returns:

the platform type

getDataDirectory

java.nio.file.Path getDataDirectory()

Gets the plugins main data storage directory

Returns:

the platforms' data folder

getResourceStream

default java.io.InputStream getResourceStream(java.lang.String path)

Gets a bundled resource file from the jar

Parameters:

path - the path of the file

Returns:

the file as an input stream

getPlayerCount

int getPlayerCount()

Gets the number of users online on the platform

Returns:

the number of users

getPlayerList

java.util.Collection<java.lang.String> getPlayerList()

Gets the usernames of the users online on the platform

Returns:

a List of usernames

getOnlinePlayers

java.util.Collection<java.util.UUID> getOnlinePlayers()

Gets the UUIDs of the users online on the platform

Returns:

a Set of UUIDs

isPlayerOnline

boolean isPlayerOnline(java.util.UUID uniqueId)

Checks if a user is online

Parameters:

uniqueId - the users external uuid

Returns:

true if the user is online

getPlayer

java.util.Optional<?> getPlayer(java.util.UUID uuid)

Get a player object

Parameters:

uuid - of player

Returns:

return if the player is present, empty if not