MapArchObject (Gridarta)

java.lang.Object
- net.sf.gridarta.model.maparchobject.AbstractMapArchObject<MapArchObject>
- - net.sf.gridarta.var.crossfire.model.maparchobject.MapArchObject

All Implemented Interfaces:

java.io.Serializable, MapArchObject<MapArchObject>
```
public class MapArchObject
extends AbstractMapArchObject<MapArchObject>
```
MapArchObject contains the specific meta data about a map that is stored in the map-arch, at the very beginning of the map file. The map meta data is information like mapSize, difficulty level, darkness etc.).

See Also:

Serialized Form

Todo:

This class should be changed so map attributes are reflected in a more generic way like arch attributes.

Note:

Though this class is named MapArchObject, it is not a subclass of GameObject; the name is for technical reasons, not for semantic / inheritance!

Field Summary
- Fields inherited from class net.sf.gridarta.model.maparchobject.AbstractMapArchObject
  MAP_NAME_UNNAMED

Constructor Summary

Constructors
Constructor and Description

MapArchObject()
Creates a new instance.

Constructors
Constructor and Description
`MapArchObject()` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLore(@NotNull java.lang.String text)` Appends text to the map lore.
`@NotNull MapArchObject`	`createClone()` Creates a copy of this object.
`boolean`	`equals(@Nullable java.lang.Object obj)`
`@NotNull java.lang.String`	`getBackgroundMusic()` Returns the background music to play.
`int`	`getFirstLoad()` Returns the timestamp the Crossfire server has loaded this map.
`int`	`getHumidity()` Returns the humidity.
`@NotNull java.lang.String`	`getLore()` Returns the map lore.
`int`	`getPressure()` Returns the pressure.
`@NotNull java.lang.String`	`getRegion()` Returns the region the map is in.
`@NotNull java.lang.String`	`getResetGroup()` Returns the reset group.
`double`	`getShopGreed()` Returns the greed of the shop.
`@NotNull java.lang.String`	`getShopItems()` Returns the item spec for the shop.
`int`	`getShopMax()` Returns the maximum price the shop will trade for.
`int`	`getShopMin()` Returns the minimum price the shop will trade for.
`@NotNull java.lang.String`	`getShopRace()` Returns the preferred race of the shop.
`int`	`getSky()` Returns the sky settings.
`int`	`getTemperature()` Returns the temperature.
`int`	`getWindDirection()` Returns the wind direction.
`int`	`getWindSpeed()` Returns the wind speed.
`int`	`hashCode()`
`boolean`	`isNoSmooth()` Returns whether this map is no smooth.
`boolean`	`isTemplate()` Returns whether this map is a template map.
`boolean`	`isUnique()` Get whether this map is unique.
`void`	`setBackgroundMusic(@NotNull java.lang.String backgroundMusic)` Sets the background music to play.
`void`	`setDifficulty(int difficulty)` Sets the map's difficulty.
`void`	`setFirstLoad(int firstLoad)` Sets the timestamp the Crossfire server has loaded this map.
`void`	`setHumidity(int humidity)` Sets the humidity.
`void`	`setLore(@NotNull java.lang.String text)` Sets the map lore.
`void`	`setNoSmooth(boolean noSmooth)` Sets whether this map is no smooth.
`void`	`setPressure(int pressure)` Sets the pressure.
`void`	`setRegion(@NotNull java.lang.String region)` Sets the region the map is in.
`void`	`setResetGroup(@NotNull java.lang.String resetGroup)` Sets the reset group.
`void`	`setShopGreed(double shopGreed)` Sets the greed of the shop.
`void`	`setShopItems(@NotNull java.lang.String shopItems)` Sets the item spec for the shop.
`void`	`setShopMax(int shopMax)` Sets the maximum price the shop will trade for.
`void`	`setShopMin(int shopMin)` Sets the minimum price the shop will trade for.
`void`	`setShopRace(@NotNull java.lang.String shopRace)` Sets the preferred race of the shop.
`void`	`setSky(int sky)` Sets the sky settings.
`void`	`setState(@NotNull MapArchObject mapArchObject)` Resets the state of this object to the state of the given map arch object.
`void`	`setTemperature(int temperature)` Sets the temperature.
`void`	`setTemplate(boolean template)` Sets whether this map is a template map.
`void`	`setUnique(boolean unique)` Set whether this map is unique.
`void`	`setWindDirection(int windDirection)` sets the wind direction.
`void`	`setWindSpeed(int windSpeed)` Sets the wind speed.

Methods inherited from class net.sf.gridarta.model.maparchobject.AbstractMapArchObject
addMapArchObjectListener, addText, beginTransaction, calculateTilePath, calculateTilePaths, endTransaction, endTransaction, getDarkness, getDifficulty, getEnter, getEnterX, getEnterY, getMapName, getMapSize, getResetTimeout, getSwapTime, getText, getTilePath, getTilePaths, isFixedReset, isOutdoor, isPointValid, isTilePathAuto, removeMapArchObjectListener, setDarkness, setEnterX, setEnterY, setFixedReset, setMapName, setMapSize, setModified, setOutdoor, setResetTimeout, setSwapTime, setText, setTilePath, updateModifiedAttribute

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapArchObject
```
public MapArchObject()
```
    Creates a new instance.
- Method Detail
  - setState
```
public void setState(@NotNull
                     @NotNull MapArchObject mapArchObject)
```
    Description copied from interface: MapArchObject
    
    Resets the state of this object to the state of the given map arch object.
    
    Specified by:
    
    setState in interface MapArchObject<MapArchObject>
    
    Overrides:
    
    setState in class AbstractMapArchObject<MapArchObject>
    
    Parameters:
    
    mapArchObject - the map arch object to copy the state from
  - isUnique
```
public boolean isUnique()
```
    Get whether this map is unique.
    
    Returns:
    
    whether this map is unique
  - setUnique
```
public void setUnique(boolean unique)
```
    Set whether this map is unique.
    
    Parameters:
    
    unique - whether this map should be unique
  - isTemplate
```
public boolean isTemplate()
```
    Returns whether this map is a template map.
    
    Returns:
    
    whether this map is a template map
  - setTemplate
```
public void setTemplate(boolean template)
```
    Sets whether this map is a template map.
    
    Parameters:
    
    template - whether this map is a template map
  - isNoSmooth
```
public boolean isNoSmooth()
```
    Returns whether this map is no smooth.
    
    Returns:
    
    whether this map is no smooth
  - setNoSmooth
```
public void setNoSmooth(boolean noSmooth)
```
    Sets whether this map is no smooth.
    
    Parameters:
    
    noSmooth - whether this map is no smooth
  - getRegion
```
@NotNull
public @NotNull java.lang.String getRegion()
```
    Returns the region the map is in.
    
    Returns:
    
    the region the map is in
  - setRegion
```
public void setRegion(@NotNull
                      @NotNull java.lang.String region)
```
    Sets the region the map is in.
    
    Parameters:
    
    region - the region the map is in
  - getBackgroundMusic
```
@NotNull
public @NotNull java.lang.String getBackgroundMusic()
```
    Returns the background music to play.
    
    Returns:
    
    the background music to play
  - setBackgroundMusic
```
public void setBackgroundMusic(@NotNull
                               @NotNull java.lang.String backgroundMusic)
```
    Sets the background music to play.
    
    Parameters:
    
    backgroundMusic - the background music to play
  - getShopItems
```
@NotNull
public @NotNull java.lang.String getShopItems()
```
    Returns the item spec for the shop.
    
    Returns:
    
    the item spec for the shop
  - setShopItems
```
public void setShopItems(@NotNull
                         @NotNull java.lang.String shopItems)
```
    Sets the item spec for the shop.
    
    Parameters:
    
    shopItems - the item spec for the shop
  - getShopRace
```
@NotNull
public @NotNull java.lang.String getShopRace()
```
    Returns the preferred race of the shop.
    
    Returns:
    
    the preferred race of the shop
  - setShopRace
```
public void setShopRace(@NotNull
                        @NotNull java.lang.String shopRace)
```
    Sets the preferred race of the shop.
    
    Parameters:
    
    shopRace - the preferred race of te shop
  - getShopMin
```
public int getShopMin()
```
    Returns the minimum price the shop will trade for.
    
    Returns:
    
    the minimum price the shop will trade for
  - setShopMin
```
public void setShopMin(int shopMin)
```
    Sets the minimum price the shop will trade for.
    
    Parameters:
    
    shopMin - the minimum price the shop will trade for
  - getShopMax
```
public int getShopMax()
```
    Returns the maximum price the shop will trade for.
    
    Returns:
    
    the maximum price the shop will trade for
  - setShopMax
```
public void setShopMax(int shopMax)
```
    Sets the maximum price the shop will trade for.
    
    Parameters:
    
    shopMax - the maximum price the shop will trade for
  - getShopGreed
```
public double getShopGreed()
```
    Returns the greed of the shop.
    
    Returns:
    
    the greed of the shop
  - setShopGreed
```
public void setShopGreed(double shopGreed)
```
    Sets the greed of the shop.
    
    Parameters:
    
    shopGreed - the greed of the shop
  - getTemperature
```
public int getTemperature()
```
    Returns the temperature.
    
    Returns:
    
    the temperature
  - setTemperature
```
public void setTemperature(int temperature)
```
    Sets the temperature.
    
    Parameters:
    
    temperature - the temperature
  - getPressure
```
public int getPressure()
```
    Returns the pressure.
    
    Returns:
    
    the pressure
  - setPressure
```
public void setPressure(int pressure)
```
    Sets the pressure.
    
    Parameters:
    
    pressure - the pressure
  - getHumidity
```
public int getHumidity()
```
    Returns the humidity.
    
    Returns:
    
    the humidity
  - setHumidity
```
public void setHumidity(int humidity)
```
    Sets the humidity.
    
    Parameters:
    
    humidity - the humidity
  - getWindSpeed
```
public int getWindSpeed()
```
    Returns the wind speed.
    
    Returns:
    
    the wind speed
  - setWindSpeed
```
public void setWindSpeed(int windSpeed)
```
    Sets the wind speed.
    
    Parameters:
    
    windSpeed - the wind speed
  - getWindDirection
```
public int getWindDirection()
```
    Returns the wind direction.
    
    Returns:
    
    the wind direction
  - setWindDirection
```
public void setWindDirection(int windDirection)
```
    sets the wind direction.
    
    Parameters:
    
    windDirection - the wind direction
  - getSky
```
public int getSky()
```
    Returns the sky settings.
    
    Returns:
    
    the sky settings
  - setSky
```
public void setSky(int sky)
```
    Sets the sky settings.
    
    Parameters:
    
    sky - the sky settings
  - addLore
```
public void addLore(@NotNull
                    @NotNull java.lang.String text)
```
    Appends text to the map lore.
    
    Parameters:
    
    text - the text to append
  - setLore
```
public void setLore(@NotNull
                    @NotNull java.lang.String text)
```
    Sets the map lore.
    
    Parameters:
    
    text - the map lore
  - getLore
```
@NotNull
public @NotNull java.lang.String getLore()
```
    Returns the map lore.
    
    Returns:
    
    the map lore
  - setDifficulty
```
public void setDifficulty(int difficulty)
```
    Description copied from interface: MapArchObject
    
    Sets the map's difficulty.
    
    Specified by:
    
    setDifficulty in interface MapArchObject<MapArchObject>
    
    Overrides:
    
    setDifficulty in class AbstractMapArchObject<MapArchObject>
    
    Parameters:
    
    difficulty - the new difficulty for this map
  - getFirstLoad
```
public int getFirstLoad()
```
    Returns the timestamp the Crossfire server has loaded this map.
    
    Returns:
    
    the timestamp
  - setFirstLoad
```
public void setFirstLoad(int firstLoad)
```
    Sets the timestamp the Crossfire server has loaded this map.
    
    Parameters:
    
    firstLoad - the timestamp
  - getResetGroup
```
@NotNull
public @NotNull java.lang.String getResetGroup()
```
    Returns the reset group.
    
    Returns:
    
    the reset group
  - setResetGroup
```
public void setResetGroup(@NotNull
                          @NotNull java.lang.String resetGroup)
```
    Sets the reset group.
    
    Parameters:
    
    resetGroup - the reset group
  - equals
```
public boolean equals(@Nullable
                      @Nullable java.lang.Object obj)
```
    Overrides:
    
    equals in class AbstractMapArchObject<MapArchObject>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractMapArchObject<MapArchObject>
  - createClone
```
@NotNull
public @NotNull MapArchObject createClone()
```
    Description copied from interface: MapArchObject
    
    Creates a copy of this object.
    
    Returns:
    
    the newly created clone of this object

Class MapArchObject

Field Summary

Fields inherited from class net.sf.gridarta.model.maparchobject.AbstractMapArchObject

Constructor Summary

Method Summary

Methods inherited from class net.sf.gridarta.model.maparchobject.AbstractMapArchObject

Methods inherited from class java.lang.Object

Constructor Detail

MapArchObject

Method Detail

setState

isUnique

setUnique

isTemplate

setTemplate

isNoSmooth

setNoSmooth

getRegion

setRegion

getBackgroundMusic

setBackgroundMusic

getShopItems

setShopItems

getShopRace

setShopRace

getShopMin

setShopMin

getShopMax

setShopMax

getShopGreed

setShopGreed

getTemperature

setTemperature

getPressure

setPressure

getHumidity

setHumidity

getWindSpeed

setWindSpeed

getWindDirection

setWindDirection

getSky

setSky

addLore

setLore

getLore

setDifficulty

getFirstLoad

setFirstLoad

getResetGroup

setResetGroup

equals

hashCode

createClone