net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

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

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

Public Member Functions
boolean	doAction (final boolean performAction)
void	setAction (@NotNull final Action action, @NotNull final String name)

Protected Member Functions
	AbstractMoveSquareAction (@NotNull final SelectedSquareModel< G, A, R > selectedSquareModel, @Nullable final MapManager< G, A, R > mapManager)
abstract boolean	doAction (boolean performAction, @Nullable G gameObject)

Private Member Functions
void	setMapModel (@Nullable final MapModel< G, A, R > mapModel)
void	updateAction ()

Private Attributes
Action	action
final MapManagerListener< G, A, R >	mapManagerListener
MapModel< G, A, R >	mapModel
final MapModelListener< G, A, R >	mapModelListener
final SelectedSquareModel< G, A, R >	selectedSquareModel
final SelectedSquareModelListener< G, A, R >	selectedSquareModelListener

Detailed Description

Abstract base class for actions that move the selected game object in the SelectedSquareModel.

Author

Andreas Kirschbaum

Definition at line 47 of file AbstractMoveSquareAction.java.

Constructor & Destructor Documentation

AbstractMoveSquareAction()

net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.AbstractMoveSquareAction ( @NotNull final SelectedSquareModel< G, A, R >  selectedSquareModel, @Nullable final MapManager< G, A, R >  mapManager  )

protected

Creates a new instance.

Parameters

selectedSquareModel	the selected square model to update
mapManager	the map manager to track or null

Definition at line 150 of file AbstractMoveSquareAction.java.

Member Function Documentation

doAction() [1/2]

abstract boolean net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAction ( boolean  performAction, @Nullable G  gameObject  )

abstractprotected

Executes the action.

Parameters

performAction	whether the action should be performed
gameObject	the current game object or null if none is selected

Returns

whether the action was or can be performed

doAction() [2/2]

boolean net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAction

(

final boolean

performAction

)

Executes the action.

Parameters

performAction

whether the action should be performed

Returns

whether the action was or can be performed

Definition at line 163 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.doAction(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareBottomMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareBottomSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareDownMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareDownSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvMulti3(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvMulti4(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle2(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle3(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvIntoHead1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvMulti1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvSingle1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareTopMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareTopSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareUpMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareUpSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testMoveEnvIntoSelectedMapSquare(), net.sf.gridarta.action.SelectedSquareActionsTest.testMoveTailPart(), and net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.updateAction().

Here is the caller graph for this function:

setAction()

void net.sf.gridarta.action.AbstractMoveSquareAction< 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 177 of file AbstractMoveSquareAction.java.

setMapModel()

void net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMapModel ( @Nullable final MapModel< G, A, R >  mapModel )

private

Called whether the current map has changed. Updates listeners attached to the current map.

Parameters

mapModel

the new map model

Definition at line 196 of file AbstractMoveSquareAction.java.

updateAction()

void net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction ( )

private

Updates the enabled state of action.

Definition at line 185 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.setAction(), and net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.setMapModel().

Here is the caller graph for this function:

Member Data Documentation

action

Action net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action

private

The Action for this instance. May be

null 

.

Definition at line 65 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.setAction(), and net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.updateAction().

mapManagerListener

final MapManagerListener<G, A, R> net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapManagerListener

private

Initial value:

= new MapManagerListener<G, A, R>() {
 
        @Override
        public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
            setMapModel(mapControl == null ? null : mapControl.getMapModel());
        }
 
        @Override
        public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
        }
 
        @Override
        public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
        }
 
        @Override
        public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
        }
 
    }

The map manager listener.

Definition at line 71 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.AbstractMoveSquareAction().

mapModel

MapModel<G, A, R> net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapModel

private

The currently active MapModel.

Definition at line 59 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.setMapModel().

mapModelListener

final MapModelListener<G, A, R> net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapModelListener

private

The MapModelListener attached to mapModel.

Definition at line 96 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.setMapModel().

selectedSquareModel

final SelectedSquareModel<G, A, R> net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.selectedSquareModel

private

The SelectedSquareModel that is updated.

Definition at line 53 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.AbstractMoveSquareAction(), and net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.doAction().

selectedSquareModelListener

final SelectedSquareModelListener<G, A, R> net.sf.gridarta.action.AbstractMoveSquareAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.selectedSquareModelListener

private

Initial value:

= new SelectedSquareModelListener<G, A, R>() {
 
        @Override
        public void selectionChanged(@Nullable final MapSquare<G, A, R> mapSquare, @Nullable final G gameObject) {
            updateAction();
        }
 
    }

The SelectedSquareModelListener attached to {}.

Definition at line 136 of file AbstractMoveSquareAction.java.

Referenced by net.sf.gridarta.action.AbstractMoveSquareAction< G, A, R >.AbstractMoveSquareAction().

---

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

• src/gridarta/src/main/java/net/sf/gridarta/action/AbstractMoveSquareAction.java