Gridarta Editor
net.sf.gridarta.model.maparchobject.TestMapArchObject Class Reference

A MapArchObject implementation for testing purposes. More...

+ Inheritance diagram for net.sf.gridarta.model.maparchobject.TestMapArchObject:
+ Collaboration diagram for net.sf.gridarta.model.maparchobject.TestMapArchObject:

Public Member Functions

TestMapArchObject createClone ()
 
 TestMapArchObject ()
 Creates a new instance. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.maparchobject.AbstractMapArchObject< TestMapArchObject >
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...
 

Protected Member Functions

TestMapArchObject getThis ()
 
- Protected Member Functions inherited from net.sf.gridarta.model.maparchobject.AbstractMapArchObject< TestMapArchObject >
 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

 TestMapArchObject (@NotNull final TestMapArchObject mapArchObject)
 Creates a new instance as a copy of another map arch object. More...
 

Static Private Attributes

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

Additional Inherited Members

- Static Public Attributes inherited from net.sf.gridarta.model.maparchobject.AbstractMapArchObject< TestMapArchObject >
static final String MAP_NAME_UNNAMED
 The name of an unnamed map. More...
 

Detailed Description

A MapArchObject implementation for testing purposes.

Author
Andreas Kirschbaum

Definition at line 28 of file TestMapArchObject.java.

Constructor & Destructor Documentation

◆ TestMapArchObject() [1/2]

net.sf.gridarta.model.maparchobject.TestMapArchObject.TestMapArchObject ( )

Creates a new instance.

Definition at line 38 of file TestMapArchObject.java.

Referenced by net.sf.gridarta.model.maparchobject.TestMapArchObject.createClone().

+ Here is the caller graph for this function:

◆ TestMapArchObject() [2/2]

net.sf.gridarta.model.maparchobject.TestMapArchObject.TestMapArchObject ( @NotNull final TestMapArchObject  mapArchObject)
private

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

Parameters
mapArchObjectthe other map arch object TypeMayBeWeakened

Definition at line 46 of file TestMapArchObject.java.

Member Function Documentation

◆ createClone()

TestMapArchObject net.sf.gridarta.model.maparchobject.TestMapArchObject.createClone ( )

Definition at line 52 of file TestMapArchObject.java.

References net.sf.gridarta.model.maparchobject.TestMapArchObject.TestMapArchObject().

+ Here is the call graph for this function:

◆ getThis()

TestMapArchObject net.sf.gridarta.model.maparchobject.TestMapArchObject.getThis ( )
protected

Definition at line 58 of file TestMapArchObject.java.

Member Data Documentation

◆ serialVersionUID

final long net.sf.gridarta.model.maparchobject.TestMapArchObject.serialVersionUID = 1L
staticprivate

The serial version UID.

Definition at line 33 of file TestMapArchObject.java.


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