Package megamek.client

Class SBFClient

java.lang.Object

megamek.client.AbstractClient

megamek.client.SBFClient

All Implemented Interfaces:

IClient

public class SBFClient
extends AbstractClient

This is the game client for Strategic BattleForce games, as one would think.

Nested Class Summary

Nested classes/interfaces inherited from class megamek.client.AbstractClient

AbstractClient.ConnectionHandler

Field Summary

Fields inherited from class megamek.client.AbstractClient

awaitingSave, bots, connected, connection, connectionListener, connThread, disconnectFlag, host, iconCache, localPlayerNumber, log, name, phaseReport, port, roundReport, unitNameTracker

Constructor Summary

Constructors

Constructor	Description
SBFClient(String name, String host, int port)	Construct a client which will try to connect.

Method Summary

Modifier and Type	Method	Description
protected void	cacheImgTag(InGameObject unit)	Hashtable for storing img tags containing base64Text src.
SBFGame	getGame()	Returns the game of this client as a game-type independent IGame.
protected boolean	handleGameSpecificPacket(Packet packet)	Handles any Packets that are specific to the game type (TW, AS...).
boolean	isMyTurn()
void	moveUnit(SBFMovePath movePath)
protected void	receiveEntities(Packet packet)	Loads the entities from the data in the net command.
void	sendAttackData(List<EntityAction> attacks, int formationId)

Methods inherited from class megamek.client.AbstractClient

addCloseClientListener, changePhase, checkDuplicateNamesDuringAdd, connect, correctName, die, disconnected, fireSaveCompleted, flushConn, getBots, getHost, getLocalPlayerNumber, getName, getPort, handleGameIndependentPacket, handlePacket, initGameLog, isAwaitingSave, isBot, isConnected, keepGameLog, memDump, possiblyWriteToLog, receivePlayerInfo, receiveUnitReplace, send, sendArtilleryRevealPreference, sendChat, sendDone, sendNextPlayer, sendPause, sendPlayerInfo, sendPlayerInfo, sendServerChat, sendUnpause, setAwaitingSave, setLocalPlayerNumber, setName, setSaveCompletionCallback, updateConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface megamek.client.IClient

getBotClient, getInGameObject, getInGameObjects, getLocalPlayer, getPlayer, isLocalBot, playerExists

Constructor Details

SBFClient

public SBFClient(String name,
 String host,
 int port)

Construct a client which will try to connect. If the connection fails, it will alert the player, free resources and hide the frame.

Parameters:

name - the player name for this client

host - the hostname

port - the host port

Method Details

getGame

public SBFGame getGame()

Description copied from interface: IClient

Returns the game of this client as a game-type independent IGame. Note that the game object is only updated, not replaced and a reference to it can therefore be kept.

Returns:

The game of this client

isMyTurn

public boolean isMyTurn()

Returns:

True when the currently active turn is a turn for the local player

handleGameSpecificPacket

protected boolean handleGameSpecificPacket(Packet packet)

Description copied from class: AbstractClient

Handles any Packets that are specific to the game type (TW, AS...). When implementing this, make sure that this doesn't do duplicate actions with AbstractClient.handleGameIndependentPacket(Packet) - but packets may be handled in both methods (all packets traverse both methods).

When making changes, do not forget to update Precognition which is a Client clone but unfortunately not a subclass.

Specified by:

handleGameSpecificPacket in class AbstractClient

Parameters:

packet - The packet to handle

Returns:

True when the packet has been handled

receiveEntities

protected void receiveEntities(Packet packet)
                        throws InvalidPacketDataException

Loads the entities from the data in the net command.

Throws:

InvalidPacketDataException

cacheImgTag

protected void cacheImgTag(InGameObject unit)

Hashtable for storing img tags containing base64Text src.

moveUnit

public void moveUnit(SBFMovePath movePath)

sendAttackData

public void sendAttackData(List<EntityAction> attacks,
 int formationId)