Selects valid exit game objects from maps. More...

Inheritance diagram for net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
	ExitMatcher (@NotNull final GameObjectMatcher exitMatcher)
	Creates a new instance. More...

G	getExit (@NotNull final MapModel< G, A, R > mapModel, @Nullable final Point point)
	Returns an exit game object on a given map square. More...

G	getExit (@Nullable final G exit)
	Returns whether the given game object is an exit game object. More...

G	getValidExit (@NotNull final MapModel< G, A, R > mapModel, @NotNull final Point point)
	Returns an exit game object on a given map square having exit information. More...

GameObject< G, A, R >	getValidExit (@Nullable final G exit)
	Returns whether the given game object is an exit game object having exit information. More...

boolean	isMatching (@NotNull final GameObject<?, ?, ?> gameObject)
	Matches a GameObject. More...

Private Member Functions
boolean	isExit (@NotNull final GameObject<?, ?, ?> gameObject)
	Returns whether a GameObject is a valid exit. More...

boolean	isValidExit (@NotNull final GameObject< G, A, R > gameObject)
	Returns whether a GameObject is a valid exit. More...

Private Attributes
final GameObjectMatcher	exitMatcher
	The matcher for selecting exit objects. More...

Static Private Attributes
static final long	serialVersionUID = 1L
	The serial version UID. More...

Detailed Description

Selects valid exit game objects from maps.

Author: Andreas Kirschbaum

Definition at line 36 of file ExitMatcher.java.

Constructor & Destructor Documentation

◆ ExitMatcher()

net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ExitMatcher ( @NotNull final GameObjectMatcher exitMatcher )

Creates a new instance.

Parameters

exitMatcher the matcher for selecting exit objects

Definition at line 53 of file ExitMatcher.java.

Member Function Documentation

◆ getExit() [1/2]

G net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getExit	(	@NotNull final MapModel< G, A, R >	mapModel,
		@Nullable final Point	point
	)

Returns an exit game object on a given map square.

Parameters

mapModel	the map model to check
point	the map square to check

Returns: the head of the exit game object or
null

if none was found

Definition at line 102 of file ExitMatcher.java.

Referenced by net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitConnect(), and net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitPaste().

Here is the caller graph for this function:

◆ getExit() [2/2]

G net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getExit ( @Nullable final G exit )

Returns whether the given game object is an exit game object.

Parameters

exit	the game object to check

Returns: the game object's head if it is an exit game object or else
null

Definition at line 122 of file ExitMatcher.java.

◆ getValidExit() [1/2]

G net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValidExit	(	@NotNull final MapModel< G, A, R >	mapModel,
		@NotNull final Point	point
	)

Returns an exit game object on a given map square having exit information.

Parameters

mapModel	the map model to check
point	the map square to check

Returns: the head of the exit game object

Definition at line 65 of file ExitMatcher.java.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doEnterExit(), net.sf.gridarta.gui.map.mapactions.ExitIterator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ExitIterator(), and net.sf.gridarta.gui.map.mapactions.ExitIterator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.findNext().

Here is the caller graph for this function:

◆ getValidExit() [2/2]

GameObject<G, A, R> net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValidExit ( @Nullable final G exit )

Returns whether the given game object is an exit game object having exit information.

Parameters

exit	the game object to check

Returns: the game object's head if it is an exit game object or else
null

Definition at line 86 of file ExitMatcher.java.

◆ isExit()

boolean net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isExit ( @NotNull final GameObject<?, ?, ?> gameObject )

private

Returns whether a GameObject is a valid exit.

Parameters

gameObject the exit game object

Returns: whether the game object has "slaying" set

Definition at line 144 of file ExitMatcher.java.

Here is the caller graph for this function:

◆ isMatching()

boolean net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isMatching ( @NotNull final GameObject<?, ?, ?> gameObject )

Matches a GameObject.

Parameters

gameObject

the

GameObject

to match

Returns: true

if this matcher matches the given game object, otherwise
false

Implements net.sf.gridarta.model.match.GameObjectMatcher.

Definition at line 149 of file ExitMatcher.java.

◆ isValidExit()

boolean net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isValidExit ( @NotNull final GameObject< G, A, R > gameObject )

private

Returns whether a GameObject is a valid exit.

Parameters

gameObject the exit game object

Returns: whether the game object is a valid exit

Definition at line 135 of file ExitMatcher.java.

Referenced by net.sf.gridarta.model.exitconnector.ExitMatcher< net.sf.gridarta.model.gameobject.TestGameObject, net.sf.gridarta.model.maparchobject.TestMapArchObject, net.sf.gridarta.model.archetype.TestArchetype >.getValidExit().

Here is the caller graph for this function:

Member Data Documentation

◆ exitMatcher

final GameObjectMatcher net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.exitMatcher

private

The matcher for selecting exit objects.

Definition at line 47 of file ExitMatcher.java.

Referenced by net.sf.gridarta.model.exitconnector.ExitMatcher< net.sf.gridarta.model.gameobject.TestGameObject, net.sf.gridarta.model.maparchobject.TestMapArchObject, net.sf.gridarta.model.archetype.TestArchetype >.ExitMatcher(), and net.sf.gridarta.model.exitconnector.ExitMatcher< net.sf.gridarta.model.gameobject.TestGameObject, net.sf.gridarta.model.maparchobject.TestMapArchObject, net.sf.gridarta.model.archetype.TestArchetype >.isExit().

◆ serialVersionUID

final long net.sf.gridarta.model.exitconnector.ExitMatcher< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.serialVersionUID = 1L

staticprivate

The serial version UID.

Definition at line 41 of file ExitMatcher.java.

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

src/model/src/main/java/net/sf/gridarta/model/exitconnector/ExitMatcher.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExitMatcher()

Member Function Documentation

◆ getExit() [1/2]

◆ getExit() [2/2]

◆ getValidExit() [1/2]

◆ getValidExit() [2/2]

◆ isExit()

◆ isMatching()

◆ isValidExit()

Member Data Documentation

◆ exitMatcher

◆ serialVersionUID