cloud.timo.TimoCloud.api.objects

Interface ServerObject

All Superinterfaces:

IdentifiableObject

public interface ServerObject
extends IdentifiableObject

Method Summary

Modifier and Type	Method and Description
APIRequestFuture<java.lang.Void>	executeCommand(java.lang.String command) Executes the given command as ConsoleSender on the server
BaseObject	getBase() Returns the base the server has been started by
java.lang.String	getExtra() An extra is a custom value users can set per API.
ServerGroupObject	getGroup()
java.lang.String	getId()
java.net.InetAddress	getIpAddress()
APIRequestFuture<LogFractionObject>	getLogFraction(long startTime)
APIRequestFuture<LogFractionObject>	getLogFraction(long startTime, long endTime)
java.lang.String	getMap() If a server's map is assigned randomly, the map name will be the part of the map directory's name after the '_'.
int	getMaxPlayerCount() The server's maximum player count
MessageClientAddress	getMessageAddress()
java.lang.String	getMotd() The server's MOTD (= message of the day)
java.lang.String	getName()
int	getOnlinePlayerCount() The server's current online player count
java.util.Collection<PlayerObject>	getOnlinePlayers()
int	getPort()
java.net.InetSocketAddress	getSocketAddress()
java.lang.String	getState()
boolean	isSortedOut()
void	sendPluginMessage(PluginMessage message) Send a plugin message to the server
APIRequestFuture<java.lang.Void>	setExtra(java.lang.String extra) An extra is a custom value users can set per API.
APIRequestFuture<java.lang.Void>	setState(java.lang.String state) Sets the server's state and sends it to TimoCloud BungeeCord
APIRequestFuture<java.lang.Void>	stop() Stops the server

Method Detail

getName

java.lang.String getName()

Specified by:

getName in interface IdentifiableObject

Returns:

The server's name

getId

java.lang.String getId()

Specified by:

getId in interface IdentifiableObject

Returns:

The server's unique id

getGroup

ServerGroupObject getGroup()

Returns:

The group the server is part of

getState

java.lang.String getState()

Returns:

The server's state

setState

APIRequestFuture<java.lang.Void> setState(java.lang.String state)

Sets the server's state and sends it to TimoCloud BungeeCord

Parameters:

state - The state, e.g. 'INGAME' or 'FULL'

Returns:

A future being completed when the state was changed

getExtra

java.lang.String getExtra()

An extra is a custom value users can set per API. An example use case would be 'Teaming' or 'NoTeaming'

setExtra

APIRequestFuture<java.lang.Void> setExtra(java.lang.String extra)

An extra is a custom value users can set per API. An example use case would be 'Teaming' or 'NoTeaming'

Returns:

A future being completed when the extra was changed

getMap

java.lang.String getMap()

If a server's map is assigned randomly, the map name will be the part of the map directory's name after the '_'. E.g. 'BedWars_VILLAGE' becomes 'VILLAGE'. If no random maps exists, the 'defaultMapName' property from config.yml will be used.

getMotd

java.lang.String getMotd()

The server's MOTD (= message of the day)

getOnlinePlayers

java.util.Collection<PlayerObject> getOnlinePlayers()

Returns:

A collection of all online players

getOnlinePlayerCount

int getOnlinePlayerCount()

The server's current online player count

getMaxPlayerCount

int getMaxPlayerCount()

The server's maximum player count

getBase

BaseObject getBase()

Returns the base the server has been started by

getSocketAddress

java.net.InetSocketAddress getSocketAddress()

Returns:

The server's IP address and port players can connect to

getIpAddress

java.net.InetAddress getIpAddress()

Returns:

The server's IP address

getPort

int getPort()

Returns:

The server's port

isSortedOut

boolean isSortedOut()

Returns:

Returns if the server's current state is contained in its group's sortOutStates list

getMessageAddress

MessageClientAddress getMessageAddress()

Returns:

The address plugin protocol to this server shall be addressed to

executeCommand

APIRequestFuture<java.lang.Void> executeCommand(java.lang.String command)

Executes the given command as ConsoleSender on the server

Parameters:

command - Without leading /

Returns:

A future being completed when the command was executed

stop

APIRequestFuture<java.lang.Void> stop()

Stops the server

Returns:

A future being completed when the server was stopped

sendPluginMessage

void sendPluginMessage(PluginMessage message)

Send a plugin message to the server

Parameters:

message - The message which shall be sent

getLogFraction

APIRequestFuture<LogFractionObject> getLogFraction(long startTime,
                                                   long endTime)

Parameters:

startTime - The timestamp at which the record of the log should start (0 if you want all log entries since the server's start)

endTime - The timestamp at which the record of the log should end

Returns:

A LogFractionObject containing all log entries within the given slot of time

getLogFraction

APIRequestFuture<LogFractionObject> getLogFraction(long startTime)

Parameters:

startTime - The timestamp at which the record of the log should start (0 if you want all log entries since the server's start)

Returns:

A LogFractionObject containing all log entries after the given start time