com.realtime.crossfire.jxclient.server.crossfire

Class NumLookObjects

java.lang.Object

com.realtime.crossfire.jxclient.server.crossfire.NumLookObjects

public class NumLookObjects
extends java.lang.Object

Negotiates the size of the ground view in items with the Crossfire server.

Method Summary

Modifier and Type	Method and Description
void	connected() Called after the server connection has been established.
int	getCurrentNumLookObjects() Returns the current number of ground items.
void	processSetupNumLookObjects(@NotNull java.lang.String value) Called when a "setup num_look_objects" response has been received from the server.
void	setClientSocketState(@NotNull ClientSocketState clientSocketState) Called whenever the client socket state has changed.
void	setPreferredNumLookObjects(int preferredNumLookObjects) Sets the preferred number of ground items.
void	waitForCurrentNumLookObjectsValid() Waits until getCurrentNumLookObjects() is stable.

Methods inherited from class java.lang.Object

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

Method Detail

connected

public void connected()

Called after the server connection has been established.

processSetupNumLookObjects

public void processSetupNumLookObjects(@NotNull
                                       @NotNull java.lang.String value)
                                throws UnknownCommandException

Called when a "setup num_look_objects" response has been received from the server.

Parameters:

value - the value of the message

Throws:

UnknownCommandException - if the value cannot be parsed

setPreferredNumLookObjects

public void setPreferredNumLookObjects(int preferredNumLookObjects)

Sets the preferred number of ground items.

Parameters:

preferredNumLookObjects - the number of ground items

getCurrentNumLookObjects

public int getCurrentNumLookObjects()

Returns the current number of ground items.

Returns:

the number of ground items

waitForCurrentNumLookObjectsValid

public void waitForCurrentNumLookObjectsValid()
                                       throws java.lang.InterruptedException

Waits until getCurrentNumLookObjects() is stable. This function returns as soon as the negotiation with the Crossfire server is complete.

Throws:

java.lang.InterruptedException - if the current thread was interrupted

setClientSocketState

public void setClientSocketState(@NotNull
                                 @NotNull ClientSocketState clientSocketState)

Called whenever the client socket state has changed.

Parameters:

clientSocketState - the new client socket state