Actions that require a connection to a game server. More...

Inheritance diagram for net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	activeMapViewChanged (@Nullable final MapView< G, A, R > mapView)
	This event handler is called when the current map view has changed. More...

void	mapViewClosing (@NotNull final MapView< G, A, R > mapView)
	NoopMethodInAbstractClass More...

void	mapViewCreated (@NotNull final MapView< G, A, R > mapView)
	NoopMethodInAbstractClass More...

void	openInClient ()
	Action method for "open in client". More...

void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...

Protected Member Functions
	AbstractServerActions (@NotNull final FileControl< G, A, R > fileControl)
	Creates a new instance. More...

abstract void	resetMap (@NotNull String mapPath) throws IOException
	Resets a map identified by the given map path. More...

abstract void	teleportCharacterToMap (@NotNull String mapPath, int mapX, int mapY) throws IOException
	Teleports the character to the given map path. More...

Private Member Functions
boolean	doOpenInClient (final boolean performAction)
	Executes the "open in client" action. More...

void	updateActions ()
	Update the enabled/disabled state of all actions. More...

Private Attributes
Action	aOpenInClient
	The action for "open in client". More...

MapView< G, A, R >	currentMapView
	The currently active map or. More...

final FileControl< G, A, R >	fileControl
	The file control for saving maps. More...

Detailed Description

Actions that require a connection to a game server.

Author: Andreas Kirschbaum AbstractClassWithOnlyOneDirectInheritor

Definition at line 44 of file AbstractServerActions.java.

Constructor & Destructor Documentation

◆ AbstractServerActions()

net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.AbstractServerActions ( @NotNull final FileControl< G, A, R > fileControl )

protected

Creates a new instance.

Parameters

fileControl the file control for saving maps

Definition at line 69 of file AbstractServerActions.java.

Member Function Documentation

◆ activeMapViewChanged()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapViewChanged ( @Nullable final MapView< G, A, R > mapView )

This event handler is called when the current map view has changed.

Parameters

mapView

the new map view or

null

if no opened map view exists

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 152 of file AbstractServerActions.java.

◆ doOpenInClient()

boolean net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doOpenInClient ( final boolean performAction )

private

Executes the "open in client" action.

Parameters

performAction whether the action should be performed

Returns: whether the action was or can be performed

Definition at line 96 of file AbstractServerActions.java.

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.openInClient(), and net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.updateActions().

Here is the caller graph for this function:

◆ mapViewClosing()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewClosing ( @NotNull final MapView< G, A, R > mapView )

NoopMethodInAbstractClass

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 169 of file AbstractServerActions.java.

◆ mapViewCreated()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewCreated ( @NotNull final MapView< G, A, R > mapView )

NoopMethodInAbstractClass

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 161 of file AbstractServerActions.java.

◆ openInClient()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.openInClient ( )

Action method for "open in client".

Definition at line 77 of file AbstractServerActions.java.

◆ resetMap()

abstract void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.resetMap ( @NotNull String mapPath ) throws IOException

abstractprotected

Resets a map identified by the given map path.

Parameters

mapPath the map path to reset.

Exceptions

IOException if reset fails

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.doOpenInClient().

Here is the caller graph for this function:

◆ setAction()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction	(	@NotNull final Action	action,
		@NotNull final String	name
	)

Sets the Action instance for this editor action.

Parameters

action	the action instance
name	the name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 146 of file AbstractServerActions.java.

◆ teleportCharacterToMap()

abstract void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.teleportCharacterToMap	(	@NotNull String	mapPath,
		int	mapX,
		int	mapY
	)		throws IOException

abstractprotected

Teleports the character to the given map path.

Parameters

mapPath	the map path to teleport to
mapX	the x coordinate to teleport to
mapY	the y coordinate to teleport to

Exceptions

IOException if teleportation fails

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.doOpenInClient().

Here is the caller graph for this function:

◆ updateActions()

void net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions ( )

private

Update the enabled/disabled state of all actions.

Definition at line 84 of file AbstractServerActions.java.

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.activeMapViewChanged(), and net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.setAction().

Here is the caller graph for this function:

Member Data Documentation

◆ aOpenInClient

Action net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.aOpenInClient

private

The action for "open in client".

ThisEscapedInObjectConstruction

Definition at line 63 of file AbstractServerActions.java.

◆ currentMapView

MapView<G, A, R> net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapView

private

The currently active map or.

null

if no map is active.

Definition at line 50 of file AbstractServerActions.java.

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.doOpenInClient().

◆ fileControl

final FileControl<G, A, R> net.sf.gridarta.actions.AbstractServerActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.fileControl

private

The file control for saving maps.

Definition at line 56 of file AbstractServerActions.java.

Referenced by net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.AbstractServerActions().

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

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/actions/AbstractServerActions.java

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractServerActions()

Member Function Documentation

◆ activeMapViewChanged()

◆ doOpenInClient()

◆ mapViewClosing()

◆ mapViewCreated()

◆ openInClient()

◆ resetMap()

◆ setAction()

◆ teleportCharacterToMap()

◆ updateActions()

Member Data Documentation

◆ aOpenInClient

◆ currentMapView

◆ fileControl