Player (Hack Example Server 1.0-SNAPSHOT API)

java.lang.Object
- com.sun.sgs.example.hack.server.Player

All Implemented Interfaces:

com.sun.sgs.app.ClientSessionListener, com.sun.sgs.app.ManagedObject, Serializable
```
public class Player
extends Object
implements com.sun.sgs.app.ClientSessionListener, com.sun.sgs.app.ManagedObject, Serializable
```
This class represents a single player (user) in the system. Each player may have several characters associated with them, although typically a player only plays one character at a time. There is never more than one Player for each user, and the user may not be logged in more than once.
In addition to managing the details about a player (their name, characters, channel, current uid, etc.), this is also the point where all incoming messages from the client arrive. This means that message receipt and processing is all done while blocking on the Player rather than some general processing logic. This model helps distribute synchronization and also protect against a player trying to disrupt the system.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String NAME_PREFIX
The standard namespace prefix for all players.

Fields
Modifier and Type	Field and Description
`static String`	`NAME_PREFIX` The standard namespace prefix for all players.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`broadcastBoardUpdate(Collection<BoardSpace> updates)` Sends a graphical update of specific spaces to the client.
`void`	`disconnected(boolean graceful)` Removes this `Player` from the current game.
`PlayerCharacterManager`	`getCharacterManager()` Returns the `CharacterManager` that this `Player` uses to manage their `Character`s.
`com.sun.sgs.app.ClientSession`	`getCurrentSession()` Returns this `Player`'s current `UserID`.
`static Player`	`getInstance(String name)` Looks for an existing instance of `Player` for the given name, and creates one if an instance doesn't already exist.
`String`	`getName()` Returns the user's name.
`boolean`	`isPlaying()` Returns whether this `Player` is currently logged in and playing.
`void`	`leaveCurrentLevel()` This is used to handle leaving dungeons before we can actually call the `moveToGame` (eg, when we die).
`void`	`moveToGame(Game game)` Moves the player into the provided `Game`.
`void`	`notifyUnhandledCommand(String channelName, Commands.Command command)` Notifies the client that they have sent an unhandled command to the specified channel.
`void`	`receivedMessage(ByteBuffer message)` Called when data arrives from the a user.
`void`	`sendBoard(Board board)` Sends a complete `Board` to the client.
`void`	`sendCharacter(PlayerCharacter character)` Sends the statistics of the given character to the client.
`void`	`sendCharacterStats(int id, CharacterStats stats)` Sends a set of character statistics to the player.
`void`	`sendServerMessage(String message)` Sends a server text message (different from a client chat message) to the client.
`void`	`setCurrentSession(com.sun.sgs.app.ClientSession session)` Sets the current `Session` for this `Player`, which changes from session to session.
`String`	`toString()`
`void`	`userJoinedChannel(com.sun.sgs.app.Channel newChannel)` Called when the player joins a channel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME_PREFIX
```
public static final String NAME_PREFIX
```
    The standard namespace prefix for all players.
    
    See Also:
    Constant Field Values
- Method Detail
  - getInstance
```
public static Player getInstance(String name)
```
    Looks for an existing instance of Player for the given name, and creates one if an instance doesn't already exist. This also takes care of registering the player.
    
    Parameters:
    name - the account name of the user
    
    Returns:
    a reference to the Player with the given name
  - isPlaying
```
public boolean isPlaying()
```
    Returns whether this Player is currently logged in and playing.
    
    Returns:
    true if the player is logged in, false otherwise
  - getName
```
public String getName()
```
    Returns the user's name.
    
    Returns:
    the user's name
  - getCharacterManager
```
public PlayerCharacterManager getCharacterManager()
```
    Returns the CharacterManager that this Player uses to manage their Characters. A Player may only play as one Character at a time.
    
    Returns:
    the character manager
  - setCurrentSession
```
public void setCurrentSession(com.sun.sgs.app.ClientSession session)
```
    Sets the current Session for this Player, which changes from session to session. Typically this is called when the player first logs again, and not again until the player logs out and logs back in.
    
    Parameters:
    session - the Session associated with the player.
  - getCurrentSession
```
public com.sun.sgs.app.ClientSession getCurrentSession()
```
    Returns this Player's current UserID. Note that this is only meaningful if isPlaying returns true. Otherwise this will return null.
    
    Returns:
    the current player session, or null if the player is not currently playing
  - moveToGame
```
public void moveToGame(Game game)
```
    Moves the player into the provided Game. This causes the Player to leave the game they are currently playing (if they are currently playing a game) and notify the new game that they are joining. If the reference provided is null, then this Player is removed from the current game and sets itself as not playing any games.
    When the Player is first started, it is not playing any games. In practice, this method is only called with a value of null when the associated client logs out of the server.
    
    Parameters:
    game - the new Game, or null if the player is only being removed from a game
  - leaveCurrentLevel
```
public void leaveCurrentLevel()
```
    This is used to handle leaving dungeons before we can actually call the moveToGame (eg, when we die). It handles multiple calls while on the same level cleanly (which is done by paranoid checking when leaving dungeons).
  - userJoinedChannel
```
public void userJoinedChannel(com.sun.sgs.app.Channel newChannel)
```
    Called when the player joins a channel. In this system, the player only joins a new channel in the context of joining a new game, and the player is never on more than one channel.
    
    Parameters:
    newChannel - the new channel
  - receivedMessage
```
public void receivedMessage(ByteBuffer message)
```
    Called when data arrives from the a user. In this case, this is called any time the client associated with this Player sends a message directly to the server (i.e., not a broadcast message like a chat comment). This method, therefore, is the handler for all client messages, and so we hold the lock on the Player and not some more generally shared logic while we're processing messages.
    
    Specified by:
    
    receivedMessage in interface com.sun.sgs.app.ClientSessionListener
    
    Parameters:
    message - the data sent to the player
  - disconnected
```
public void disconnected(boolean graceful)
```
    Removes this Player from the current game.
    
    Specified by:
    
    disconnected in interface com.sun.sgs.app.ClientSessionListener
    
    Parameters:
    graceful - whether the diconnection was graceful
  - sendBoard
```
public void sendBoard(Board board)
```
    Sends a complete Board to the client.
    
    Parameters:
    board - the Board to send
  - broadcastBoardUpdate
```
public void broadcastBoardUpdate(Collection<BoardSpace> updates)
```
    Sends a graphical update of specific spaces to the client.
    
    Parameters:
    updates - the updates to send
  - notifyUnhandledCommand
```
public void notifyUnhandledCommand(String channelName,
                          Commands.Command command)
```
    Notifies the client that they have sent an unhandled command to the specified channel.
    
    Parameters:
    channelName - the name of the channel that the unhandled command was sent on
    command - the unhandled command
  - sendCharacter
```
public void sendCharacter(PlayerCharacter character)
```
    Sends the statistics of the given character to the client.
    
    Parameters:
    character - the character who's statistics will be sent
  - sendCharacterStats
```
public void sendCharacterStats(int id,
                      CharacterStats stats)
```
    Sends a set of character statistics to the player.
    
    Parameters:
    id - the character's identifier
    stats - the character statistics
  - sendServerMessage
```
public void sendServerMessage(String message)
```
    Sends a server text message (different from a client chat message) to the client.
    
    Parameters:
    message - the message to send
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Player

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_PREFIX

Method Detail

getInstance

isPlaying

getName

getCharacterManager

setCurrentSession

getCurrentSession

moveToGame

leaveCurrentLevel

userJoinedChannel

receivedMessage

disconnected

sendBoard

broadcastBoardUpdate

notifyUnhandledCommand

sendCharacter

sendCharacterStats

sendServerMessage

toString