Package com.tenio.core.entity
Interface Player
- All Known Implementing Classes:
PlayerImpl
public interface Player
The abstract player object used in the server.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clean()
void
boolean
containsProperty
(String key) boolean
long
long
getName()
Retrieve the player's name.int
getProperty
(String key) getState()
boolean
boolean
isInRoom()
boolean
boolean
boolean
isState
(PlayerState state) void
removeProperty
(String key) void
setActivated
(boolean activated) void
setCurrentRoom
(Room room) void
setLoggedIn
(boolean loggedIn) void
setPlayerSlotInCurrentRoom
(int slot) void
setProperty
(String key, Object value) void
setSession
(Session session) void
setSpectator
(boolean isSpectator) void
setState
(PlayerState state)
-
Method Details
-
getName
String getName()Retrieve the player's name. This value must be unique.- Returns:
- the player's name in (@link String}
-
containsSession
boolean containsSession() -
isState
-
getState
PlayerState getState() -
setState
-
isActivated
boolean isActivated() -
setActivated
void setActivated(boolean activated) -
isLoggedIn
boolean isLoggedIn() -
setLoggedIn
void setLoggedIn(boolean loggedIn) -
getLastLoggedInTime
long getLastLoggedInTime() -
getSession
Session getSession() -
setSession
-
isInRoom
boolean isInRoom() -
isSpectator
boolean isSpectator() -
setSpectator
void setSpectator(boolean isSpectator) -
getCurrentRoom
Room getCurrentRoom() -
setCurrentRoom
-
getLastJoinedRoomTime
long getLastJoinedRoomTime() -
getPlayerSlotInCurrentRoom
int getPlayerSlotInCurrentRoom() -
setPlayerSlotInCurrentRoom
void setPlayerSlotInCurrentRoom(int slot) -
getProperty
-
setProperty
-
containsProperty
-
removeProperty
-
clearProperties
void clearProperties() -
clean
void clean()
-