Collaboration diagram for com.realtime.crossfire.jxclient.map.PendingDirections:

Classes
class	Rec

enum	State

Public Member Functions
void	add (final int direction, final int packetNo)

void	clear ()

void	comc (final int packetNo)

Iterable< @NotNull Integer >	getPendingDirections ()

int	getRunDirection ()

void	mapScroll (final int direction)

	PendingDirections ()

void	run (final int direction)

void	tick ()

String	toString ()

Private Member Functions
void	reset ()

Private Attributes
final List< @NotNull Rec >	pendingDirections = new ArrayList<>()

int	runDirection = -1

State	state = State.IDLE

Detailed Description

Maintains pending movements of the character. Whenever a movement command is sent to the server, it is stored. When the server has executed the command, it is removed.

In case the server does not execute the movement command (for example because the character was stopped by an obstacle), the pending movements are cleared.

Author: Andreas Kirschbaum

Definition at line 40 of file PendingDirections.java.

Constructor & Destructor Documentation

◆ PendingDirections()

com.realtime.crossfire.jxclient.map.PendingDirections.PendingDirections ( )

Creates a new instance.

Definition at line 63 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.reset().

Here is the call graph for this function:

Member Function Documentation

◆ add()

void com.realtime.crossfire.jxclient.map.PendingDirections.add	(	final int	direction,
		final int	packetNo
	)

Adds a pending step.

Parameters

direction	the direction of the step
packetNo	the packet number for tracking responses

Definition at line 103 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.sendNcom().

Here is the caller graph for this function:

◆ clear()

void com.realtime.crossfire.jxclient.map.PendingDirections.clear ( )

Clears the state.

Definition at line 91 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, com.realtime.crossfire.jxclient.map.PendingDirections.reset(), and com.realtime.crossfire.jxclient.map.PendingDirections.runDirection.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.clear(), and com.realtime.crossfire.jxclient.queue.CommandQueue.sendNcom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ comc()

void com.realtime.crossfire.jxclient.map.PendingDirections.comc ( final int packetNo )

Must be called when a comc message has been received from the server.

Parameters

packetNo the packet number

Definition at line 123 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.State.EXPECT_MAP_SCROLL_OR_TICK, com.realtime.crossfire.jxclient.map.PendingDirections.Rec.getPacketNo(), com.realtime.crossfire.jxclient.map.PendingDirections.State.IDLE, com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, com.realtime.crossfire.jxclient.map.PendingDirections.reset(), and com.realtime.crossfire.jxclient.map.PendingDirections.state.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.comcReceived().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPendingDirections()

Iterable<@NotNull Integer> com.realtime.crossfire.jxclient.map.PendingDirections.getPendingDirections ( )

Returns the currently pending directions.

Returns: the pending directions

Definition at line 72 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.Rec.getDirection(), and com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMapDirections.paintComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRunDirection()

int com.realtime.crossfire.jxclient.map.PendingDirections.getRunDirection ( )

Returns the direction the character is running.

Returns: the direction or -1 when not running

Definition at line 82 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, and com.realtime.crossfire.jxclient.map.PendingDirections.runDirection.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMapDirections.paintComponent().

Here is the caller graph for this function:

◆ mapScroll()

void com.realtime.crossfire.jxclient.map.PendingDirections.mapScroll ( final int direction )

Must be called when the map has been scrolled.

Parameters

direction the scrolling direction

Definition at line 145 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.State.EXPECT_MAP_SCROLL_OR_TICK, com.realtime.crossfire.jxclient.map.PendingDirections.Rec.getDirection(), com.realtime.crossfire.jxclient.map.PendingDirections.State.IDLE, com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, com.realtime.crossfire.jxclient.map.PendingDirections.reset(), and com.realtime.crossfire.jxclient.map.PendingDirections.state.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.mapScrollReceived().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void com.realtime.crossfire.jxclient.map.PendingDirections.reset ( )

private

Resets the state.

Definition at line 182 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.State.IDLE, com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, and com.realtime.crossfire.jxclient.map.PendingDirections.state.

Referenced by com.realtime.crossfire.jxclient.map.PendingDirections.clear(), com.realtime.crossfire.jxclient.map.PendingDirections.comc(), com.realtime.crossfire.jxclient.map.PendingDirections.mapScroll(), com.realtime.crossfire.jxclient.map.PendingDirections.PendingDirections(), and com.realtime.crossfire.jxclient.map.PendingDirections.tick().

Here is the caller graph for this function:

◆ run()

void com.realtime.crossfire.jxclient.map.PendingDirections.run ( final int direction )

Sets the directions the character is currently running to.

Parameters

direction the direction or -1 when not running

Definition at line 113 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, and com.realtime.crossfire.jxclient.map.PendingDirections.runDirection.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.sendNcom().

Here is the caller graph for this function:

◆ tick()

void com.realtime.crossfire.jxclient.map.PendingDirections.tick ( )

Must be called when a tick message has been received.

Definition at line 169 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.State.EXPECT_MAP_SCROLL_OR_TICK, com.realtime.crossfire.jxclient.map.PendingDirections.State.IDLE, com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections, com.realtime.crossfire.jxclient.map.PendingDirections.reset(), and com.realtime.crossfire.jxclient.map.PendingDirections.state.

Referenced by com.realtime.crossfire.jxclient.queue.CommandQueue.tickReceived().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.map.PendingDirections.toString ( )

Definition at line 195 of file PendingDirections.java.

References com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections.

Member Data Documentation

◆ pendingDirections

final List<@NotNull Rec> com.realtime.crossfire.jxclient.map.PendingDirections.pendingDirections = new ArrayList<>()

private

Records the directions of sent movement commands which have not yet been executed by the server.

Definition at line 47 of file PendingDirections.java.

◆ runDirection

int com.realtime.crossfire.jxclient.map.PendingDirections.runDirection = -1

private

The direction the character is running or -1 when not running.

Definition at line 58 of file PendingDirections.java.

Referenced by com.realtime.crossfire.jxclient.map.PendingDirections.clear(), com.realtime.crossfire.jxclient.map.PendingDirections.getRunDirection(), and com.realtime.crossfire.jxclient.map.PendingDirections.run().

◆ state

State com.realtime.crossfire.jxclient.map.PendingDirections.state = State.IDLE

private

The current state when waiting for server responses.

Definition at line 53 of file PendingDirections.java.

Referenced by com.realtime.crossfire.jxclient.map.PendingDirections.comc(), com.realtime.crossfire.jxclient.map.PendingDirections.mapScroll(), com.realtime.crossfire.jxclient.map.PendingDirections.reset(), and com.realtime.crossfire.jxclient.map.PendingDirections.tick().

The documentation for this class was generated from the following file:

src/model/src/main/java/com/realtime/crossfire/jxclient/map/PendingDirections.java

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PendingDirections()

Member Function Documentation

◆ add()

◆ clear()

◆ comc()

◆ getPendingDirections()

◆ getRunDirection()

◆ mapScroll()

◆ reset()

◆ run()

◆ tick()

◆ toString()

Member Data Documentation

◆ pendingDirections

◆ runDirection

◆ state