Base implementation of MapArchObject that covers similarities between Crossfire maps and Daimonin maps. More...

Inheritance diagram for net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >:

Collaboration diagram for net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >:

Public Member Functions
void	addMapArchObjectListener (@NotNull final MapArchObjectListener listener)
	Registers an event listener. More...

void	addText (@NotNull final String text)
	Appends 'text' to the map text. More...

void	beginTransaction ()
	Starts a new transaction. More...

String	calculateTilePath (@NotNull final Direction direction, @Nullable final MapFile mapFile)
	Calculate a single tile path in a particular direction. More...

void	calculateTilePaths (@Nullable final MapFile mapFile, @NotNull final File mapsDirectory)
	Calculates tiled paths for the map automatically. More...

void	endTransaction ()
	Ends a transaction. More...

void	endTransaction (final boolean fireEvent)
	Ends a transaction. More...

boolean	equals (@Nullable final Object obj)

int	getDarkness ()
	Returns the light / darkness of this map. More...

int	getDifficulty ()
	Returns the map's difficulty. More...

Point	getEnter ()
	Returns the enter coordinates. More...

int	getEnterX ()
	Returns the enter x coordinate. More...

int	getEnterY ()
	Returns the enter y coordinate. More...

String	getMapName ()
	Returns the map name. More...

Size2D	getMapSize ()
	Returns the map size. More...

int	getResetTimeout ()
	Returns the reset timeout (in seconds). More...

int	getSwapTime ()
	Returns the swap time (in ticks). More...

String	getText ()
	Returns the message text. More...

String	getTilePath (@NotNull final Direction direction)
	Returns a tile path. More...

int	getTilePaths ()
	Returns the number of tile paths. More...

int	hashCode ()

boolean	isFixedReset ()
	Returns whether this map uses a fixed reset. More...

boolean	isOutdoor ()
	Returns whether the map is an "outdoor" map. More...

boolean	isPointValid (@Nullable final Point pos)
	Checks whether the given coordinate is within map bounds. More...

boolean	isTilePathAuto (@NotNull final Direction direction, @Nullable final MapFile mapFile)
	Determines whether a tiled map in the specified direction is automatic tiled path or not. More...

void	removeMapArchObjectListener (@NotNull final MapArchObjectListener listener)
	Unregisters an event listener. More...

void	setDarkness (final int darkness)
	Sets the light / darkness of this map. More...

void	setDifficulty (final int difficulty)
	Sets the map's difficulty. More...

void	setEnterX (final int enterX)
	Sets the enter x coordinate. More...

void	setEnterY (final int enterY)
	Sets the enter y coordinate. More...

void	setFixedReset (final boolean fixedReset)
	Sets whether this map uses a fixed reset. More...

void	setMapName (@NotNull final String name)
	Sets the map name. More...

void	setMapSize (@NotNull final Size2D mapSize)
	Sets the map size. More...

void	setOutdoor (final boolean outdoor)
	Sets whether the map is an "outdoor" map. More...

void	setResetTimeout (final int resetTimeout)
	Sets the reset timeout (in seconds). More...

void	setState (@NotNull final A mapArchObject)
	Resets the state of this object to the state of the given map arch object. More...

void	setSwapTime (final int swapTime)
	Sets the swap time (in ticks). More...

void	setText (final String text)
	Sets the map text. More...

void	setTilePath (@NotNull final Direction direction, @NotNull final String tilePath)
	Sets a tile path. More...

void	updateModifiedAttribute (@NotNull final String userName)
	Updates the "Modified:" attribute in the message text. More...

Public Member Functions inherited from net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >
A	createClone ()
	Creates a copy of this object. More...

Static Public Attributes
static final String	MAP_NAME_UNNAMED = "<unnamed>"
	The name of an unnamed map. More...

Protected Member Functions
	AbstractMapArchObject ()
	Creates a new instance. More...

	AbstractMapArchObject (@NotNull final AbstractMapArchObject< A > mapArchObject)
	Creates a new instance as a copy of another map arch object. More...

abstract A	getThis ()
	Returns this map arch object cast to its real type. More...

void	setModified ()
	Marks this map arch object as changed. More...

Private Member Functions
void	commitTransaction ()
	Performs ending a transaction. More...

void	fireMetaChangedEvent ()
	Fires a MapMetaChangedEvent. More...

Private Attributes
boolean	attributeHasChanged
	Set if any attribute has changed inside the current transaction. More...

int	darkness
	The light / darkness of map (overall). More...

int	difficulty
	The map difficulty. More...

int	enterX
	The x coordinate for entering the map. More...

int	enterY
	The y coordinate for entering the map. More...

boolean	fixedReset
	If nonzero, the map reset time will not be updated when someone enters / exits the map. More...

final EventListenerList2< MapArchObjectListener >	listenerList = new EventListenerList2<>(MapArchObjectListener.class)
	The registered event listeners. More...

String	mapName
	The name of this map. More...

Size2D	mapSize
	The size of the map reflected by this map arch object. More...

final StringBuilder	msgText = new StringBuilder()
	The map text. More...

boolean	outdoor
	If set, this is an outdoor map. More...

int	resetTimeout
	The number of ticks that need to elapse before this map will be reset. More...

int	swapTime
	The number of ticks that must elapse after tha map has not been used before it gets swapped out. More...

final String []	tilePaths
	The map tile paths used for map tiling. More...

int	transactionDepth
	The transaction depth. More...

transient Thread	transactionThread
	The thread that performs the current transaction. More...

Static Private Attributes
static final Pattern	MAP_FILE_NAME_PATTERN = Pattern.compile("((?:(?!_(?:[\\d-]+))[\\w_])+)_([\\d-]+)_([\\d-]+)(?:_([\\d-]+))?")
	The pattern used to determine the base map name and its x/y/z coordinates from a filename. More...

static final String	MODIFIED_ATTRIBUTE = "Modified:"
	The prefix for the map attribute that is updated with the last modification timestamp. More...

static final Pattern	MODIFIED_ATTRIBUTE_PATTERN = Pattern.compile("^" + MODIFIED_ATTRIBUTE + " (.)$", Pattern.MULTILINE)
	The pattern to find the MODIFIED_ATTRIBUTE in the message text. More...

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

Detailed Description

Base implementation of MapArchObject that covers similarities between Crossfire maps and Daimonin maps.

Author: Christian Hujer; Andreas Kirschbaum

Warning: NEVER use this class in a Collection! hashCode() and equals(Object) work on non-final fields and thus will break any operation inside Collections!

Definition at line 45 of file AbstractMapArchObject.java.

Constructor & Destructor Documentation

◆ AbstractMapArchObject() [1/2]

net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.AbstractMapArchObject ( )

protected

Creates a new instance.

Definition at line 175 of file AbstractMapArchObject.java.

◆ AbstractMapArchObject() [2/2]

net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.AbstractMapArchObject ( @NotNull final AbstractMapArchObject< A > mapArchObject )

protected

Creates a new instance as a copy of another map arch object.

Parameters

mapArchObject the other map arch object

Definition at line 186 of file AbstractMapArchObject.java.

Member Function Documentation

◆ addMapArchObjectListener()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.addMapArchObjectListener ( @NotNull final MapArchObjectListener listener )

Registers an event listener.

Parameters

listener the listener to register

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 477 of file AbstractMapArchObject.java.

◆ addText()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.addText ( @NotNull final String text )

Appends 'text' to the map text.

Parameters

text	the string to add

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 553 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.atrinik.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), net.sf.gridarta.var.daimonin.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), and net.sf.gridarta.var.crossfire.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject().

Here is the caller graph for this function:

◆ beginTransaction()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.beginTransaction ( )

Starts a new transaction.

Transactions may be nested. Transactions serve the purpose of firing events to the views when more changes are known to come before the view is really required to update. Each invocation of this function requires its own invocation of endTransaction().

Beginning a nested transaction is a cheap operation.

See also: endTransaction(); endTransaction(boolean)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 495 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties().

Here is the caller graph for this function:

◆ calculateTilePath()

String net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.calculateTilePath	(	@NotNull final Direction	direction,
		@Nullable final MapFile	mapFile
	)

Calculate a single tile path in a particular direction.

Parameters

direction	the direction
mapFile	map file

Returns: Calculated tile path, empty string on failure.

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 386 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.calculateTilePaths(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.isTilePathAuto().

Here is the caller graph for this function:

◆ calculateTilePaths()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.calculateTilePaths	(	@Nullable final MapFile	mapFile,
		@NotNull final File	mapsDirectory
	)

Calculates tiled paths for the map automatically.

Parameters

mapFile	map file
mapsDirectory	maps directory

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 410 of file AbstractMapArchObject.java.

◆ commitTransaction()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.commitTransaction ( )

private

Performs ending a transaction.

Resets all transaction states and fires an event.

Definition at line 534 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.endTransaction().

Here is the caller graph for this function:

◆ endTransaction() [1/2]

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.endTransaction ( )

Ends a transaction.

Invoking this method will reduce the transaction depth by only 1.

Ending a nested operation is a cheap operation. Ending a transaction without changes also is a cheap operation.

If the last transaction is ended, the changes are committed.

Same as endTransaction(false).

See also: beginTransaction(); endTransaction(boolean)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 510 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.endTransaction(), net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties().

Here is the caller graph for this function:

◆ endTransaction() [2/2]

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.endTransaction ( final boolean fireEvent )

Ends a transaction.

Invoking this method will reduce the transaction depth by only 1.

Ending a nested operation is a cheap operation. Ending a transaction without changes also is a cheap operation.

If the last transaction is ended, the changes are committed.

An example where setting

fireEvent

to

true

is useful even though the outermost transaction is not ended is when during painting the UI should be updated though painting is not finished.

Parameters

fireEvent

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 515 of file AbstractMapArchObject.java.

◆ equals()

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.equals ( @Nullable final Object obj )

Definition at line 460 of file AbstractMapArchObject.java.

◆ fireMetaChangedEvent()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.fireMetaChangedEvent ( )

private

Fires a MapMetaChangedEvent.

Definition at line 546 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.commitTransaction(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.endTransaction().

Here is the caller graph for this function:

◆ getDarkness()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getDarkness ( )

Returns the light / darkness of this map.

(0 means fully bright)

Returns: the light / darkness of this map

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 349 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getDifficulty()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getDifficulty ( )

Returns the map's difficulty.

Returns: the map's difficulty

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 319 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getEnter()

Point net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getEnter ( )

Returns the enter coordinates.

Returns: the enter coordinates

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 269 of file AbstractMapArchObject.java.

◆ getEnterX()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getEnterX ( )

Returns the enter x coordinate.

Returns: the enter x coordinate

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 238 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getEnterY()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getEnterY ( )

Returns the enter y coordinate.

Returns: the enter y coordinate

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 253 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getMapName()

String net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getMapName ( )

Returns the map name.

Returns: the map name

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 222 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObjectTest.testParseMapArchNoAttributes(), and net.sf.gridarta.var.atrinik.model.maparchobject.MapArchObjectTest.testParseMapArchNoAttributes().

Here is the caller graph for this function:

◆ getMapSize()

Size2D net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getMapSize ( )

Returns the map size.

Returns: size of the map reflected by this MapArchObject

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 203 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObjectTest.testParseMapArchNoAttributes(), and net.sf.gridarta.var.atrinik.model.maparchobject.MapArchObjectTest.testParseMapArchNoAttributes().

Here is the caller graph for this function:

◆ getResetTimeout()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getResetTimeout ( )

Returns the reset timeout (in seconds).

Returns: the reset timeout (in seconds)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 289 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getSwapTime()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getSwapTime ( )

Returns the swap time (in ticks).

Returns: the swap time (in ticks)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 304 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getText()

String net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getText ( )

Returns the message text.

Returns: the message text

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 575 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ getThis()

abstract A net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getThis ( )

abstractprotected

Returns this map arch object cast to its real type.

Returns: this map arch object

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.isPointValid().

Here is the caller graph for this function:

◆ getTilePath()

String net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getTilePath ( @NotNull final Direction direction )

Returns a tile path.

Parameters

direction the tile path direction

Returns: the tile path

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 370 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.isTilePathAuto().

Here is the caller graph for this function:

◆ getTilePaths()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.getTilePaths ( )

Returns the number of tile paths.

Returns: the number of tile paths

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 364 of file AbstractMapArchObject.java.

◆ hashCode()

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.hashCode ( )

Definition at line 472 of file AbstractMapArchObject.java.

◆ isFixedReset()

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.isFixedReset ( )

Returns whether this map uses a fixed reset.

Returns: whether this map uses a fixed reset

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 334 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ isOutdoor()

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.isOutdoor ( )

Returns whether the map is an "outdoor" map.

Returns: whether the map is an "outdoor" map

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 274 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties(), and net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.restoreMapProperties().

Here is the caller graph for this function:

◆ isPointValid()

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.isPointValid ( @Nullable final Point pos )

Checks whether the given coordinate is within map bounds.

Parameters

pos	the coordinates to check

Returns: true
if the given coordinates are on the map, otherwise
false
(also returns
false
if
pos == null
)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 597 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.crossfire.gui.map.renderer.SmoothingRenderer.paintSmooth().

Here is the caller graph for this function:

◆ isTilePathAuto()

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.isTilePathAuto	(	@NotNull final Direction	direction,
		@Nullable final MapFile	mapFile
	)

Determines whether a tiled map in the specified direction is automatic tiled path or not.

Parameters

direction	direction of the tiled map
mapFile	map file

Returns: Whether the tile is automatic.

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 436 of file AbstractMapArchObject.java.

◆ removeMapArchObjectListener()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.removeMapArchObjectListener ( @NotNull final MapArchObjectListener listener )

Unregisters an event listener.

Parameters

listener the listener to unregister

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 482 of file AbstractMapArchObject.java.

◆ setDarkness()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setDarkness ( final int darkness )

Sets the light / darkness of this map.

Parameters

darkness the new light / darkness of this map

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 354 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), net.sf.gridarta.var.daimonin.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setDifficulty()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setDifficulty ( final int difficulty )

Sets the map's difficulty.

Parameters

difficulty the new difficulty for this map

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 324 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setEnterX()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setEnterX ( final int enterX )

Sets the enter x coordinate.

Parameters

enterX the new enter x coordinate

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 243 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setEnterY()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setEnterY ( final int enterY )

Sets the enter y coordinate.

Parameters

enterY the new enter y coordinate

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 258 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setFixedReset()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setFixedReset ( final boolean fixedReset )

Sets whether this map uses a fixed reset.

Parameters

fixedReset whether this map should use a fixed reset

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 339 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setMapName()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setMapName ( @NotNull final String name )

Sets the map name.

Parameters

name	the new map name

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 227 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.model.mapcontrol.TestMapControlCreator.newMapControl(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setMapSize()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setMapSize ( @NotNull final Size2D mapSize )

Sets the map size.

Parameters

mapSize the new map size this does not change the size of the underlying MapModel. We eventually should change that so a map size isn't stored twice.

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 208 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.model.mapcontrol.TestMapControlCreator.newMapControl(), net.sf.gridarta.model.mapmodel.TestMapModelCreator.newMapModel(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setModified()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setModified ( )

protected

Marks this map arch object as changed.

The map arch object then notifies the registered listeners of the change at the end of the transaction.

Definition at line 490 of file AbstractMapArchObject.java.

◆ setOutdoor()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setOutdoor ( final boolean outdoor )

Sets whether the map is an "outdoor" map.

Parameters

outdoor whether the map is an "outdoor" map

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 279 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setResetTimeout()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setResetTimeout ( final int resetTimeout )

Sets the reset timeout (in seconds).

Parameters

resetTimeout the new reset timeout (in seconds)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 294 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setState()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setState ( @NotNull final A mapArchObject )

Resets the state of this object to the state of the given map arch object.

Parameters

mapArchObject the map arch object to copy the state from

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 441 of file AbstractMapArchObject.java.

◆ setSwapTime()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setSwapTime ( final int swapTime )

Sets the swap time (in ticks).

Parameters

swapTime the swap time (in ticks)

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 309 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setText()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setText ( final String text )

Sets the map text.

Parameters

text	the new map text

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 563 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.atrinik.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), net.sf.gridarta.var.crossfire.gui.mappropertiesdialog.MapPropertiesDialog.modifyMapProperties(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ setTilePath()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.setTilePath	(	@NotNull final Direction	direction,
		@NotNull final String	tilePath
	)

Sets a tile path.

Parameters

direction	the tile path direction
tilePath	the new tile path

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 375 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.calculateTilePaths(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

Here is the caller graph for this function:

◆ updateModifiedAttribute()

void net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.updateModifiedAttribute ( @NotNull final String userName )

Updates the "Modified:" attribute in the message text.

Parameters

userName the user name to include

Implements net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.

Definition at line 580 of file AbstractMapArchObject.java.

Member Data Documentation

◆ attributeHasChanged

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.attributeHasChanged

private

Set if any attribute has changed inside the current transaction.

Definition at line 170 of file AbstractMapArchObject.java.

◆ darkness

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.darkness

private

The light / darkness of map (overall).

Zero means fully bright.

Definition at line 136 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.equals(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.getDarkness(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setDarkness(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

◆ difficulty

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.difficulty

private

The map difficulty.

If zero, server calculates something.

Definition at line 125 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.equals(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.getDifficulty(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setDifficulty(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

◆ enterX

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.enterX

private

The x coordinate for entering the map.

Definition at line 99 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.equals(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.getEnterX(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setEnterX(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

◆ enterY

int net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.enterY

private

The y coordinate for entering the map.

Definition at line 104 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.equals(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.getEnterY(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setEnterY(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

◆ fixedReset

boolean net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.fixedReset

private

If nonzero, the map reset time will not be updated when someone enters / exits the map.

Definition at line 131 of file AbstractMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.equals(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.isFixedReset(), net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setFixedReset(), and net.sf.gridarta.model.maparchobject.AbstractMapArchObject< MapArchObject >.setState().

◆ listenerList

final EventListenerList2<MapArchObjectListener> net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.listenerList = new EventListenerList2<>(MapArchObjectListener.class)

private

The registered event listeners.

Definition at line 150 of file AbstractMapArchObject.java.

◆ MAP_FILE_NAME_PATTERN

final Pattern net.sf.gridarta.model.maparchobject.AbstractMapArchObject< A extends MapArchObject< A >.MAP_FILE_NAME_PATTERN = Pattern.compile("((?:(?!_(?:[\\d-]+))[\\w_])+)_([\\d-]+)_([\\d-]+)(?:_([\\d-]+))?")

staticprivate

The pattern used to determine the base map name and its x/y/z coordinates from a filename.

Definition at line 76 of file AbstractMapArchObject.java.