Package com.tenio.core.api

Interface ServerApi

All Known Implementing Classes:

ServerApiImpl

public interface ServerApi

This class provides all supported APIs from the server. To use these methods, please use the singleton type instance of this interface.

See Also:

• ServerApiImpl

Method Summary

Modifier and Type	Method	Description
default void	banPlayer(Player player, String message, PlayerBanMode banMode, int durationInMinutes, int delayInSeconds)
default Room	createRoom(InitialRoomSetting setting)
Room	createRoom(InitialRoomSetting setting, Player owner)
Collection<Player>	getAllPlayers()
Player	getPlayerByName(String playerName)
Player	getPlayerBySession(Session session)
int	getPlayerCount()
Room	getRoomById(long roomId)
default void	joinRoom(Player player, Room room)
void	joinRoom(Player player, Room room, String roomPassword, int slotInRoom, boolean asSpectator)
default void	kickPlayer(Player player, String message, int delayInSeconds)
void	leaveRoom(Player player, PlayerLeaveRoomMode leaveRoomMode)
void	login(String playerName)
void	login(String playerName, Session session)
void	logout(Player player)
void	removeRoom(Room room, RoomRemoveMode removeRoomMode)
default void	sendPrivateMessage(Player sender, Player recipient, ServerMessage message)
default void	sendPublicMessage(Player sender, Room room, ServerMessage message)
default void	switchPlayerToSpectator(Player player, Room room)
default void	switchSpectatorToPlayer(Player player, Room room, int targetSlot)

Method Details

login

void login(String playerName)

login

void login(String playerName,
 Session session)

logout

void logout(Player player)

kickPlayer

default void kickPlayer(Player player,
 String message,
 int delayInSeconds)

banPlayer

default void banPlayer(Player player,
 String message,
 PlayerBanMode banMode,
 int durationInMinutes,
 int delayInSeconds)

createRoom

default Room createRoom(InitialRoomSetting setting)

createRoom

Room createRoom(InitialRoomSetting setting,
 Player owner)

getPlayerByName

Player getPlayerByName(String playerName)

getPlayerBySession

Player getPlayerBySession(Session session)

getPlayerCount

int getPlayerCount()

getAllPlayers

Collection<Player> getAllPlayers()

getRoomById

Room getRoomById(long roomId)

joinRoom

void joinRoom(Player player,
 Room room,
 String roomPassword,
 int slotInRoom,
 boolean asSpectator)

joinRoom

default void joinRoom(Player player,
 Room room)

switchPlayerToSpectator

default void switchPlayerToSpectator(Player player,
 Room room)

switchSpectatorToPlayer

default void switchSpectatorToPlayer(Player player,
 Room room,
 int targetSlot)

leaveRoom

void leaveRoom(Player player,
 PlayerLeaveRoomMode leaveRoomMode)

removeRoom

void removeRoom(Room room,
 RoomRemoveMode removeRoomMode)

sendPublicMessage

default void sendPublicMessage(Player sender,
 Room room,
 ServerMessage message)

sendPrivateMessage

default void sendPrivateMessage(Player sender,
 Player recipient,
 ServerMessage message)