Gridarta Editor
MapParameter.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.plugin.parameter;
21 
22 import java.io.File;
23 import java.io.IOException;
31 import org.jetbrains.annotations.NotNull;
32 import org.jetbrains.annotations.Nullable;
33 
37 public class MapParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractStringPluginParameter<G, A, R, MapControl<G, A, R>> {
38 
42  @NotNull
43  public static final String PARAMETER_TYPE = MapControl.class.getName();
44 
48  @NotNull
49  private static final String CURRENT_MAP = "[Current Map]";
50 
55  @NotNull
57 
62  @NotNull
63  private final PathManager pathManager;
64 
72  public MapParameter(@NotNull final MapManager<G, A, R> mapManager, @NotNull final PathManager pathManager) {
73  super(""); // XXX
74  this.mapManager = mapManager;
75  this.pathManager = pathManager;
76  }
77 
78  @NotNull
79  @Override
80  public String getParameterType() {
81  return PARAMETER_TYPE;
82  }
83 
84  @NotNull
85  @Override
86  public <T> T visit(@NotNull final PluginParameterVisitor<G, A, R, T> visitor) {
87  return visitor.visit(this);
88  }
89 
90  @NotNull
91  @Override
93  final String stringValue = getStringValue();
94  if (CURRENT_MAP.equals(stringValue)) {
95  final MapControl<G, A, R> currentMap = mapManager.getCurrentMap();
96  if (currentMap == null) {
97  throw new InvalidValueException("no map is opened");
98  }
99  currentMap.acquire(); // XXX: this causes a leak
100  return currentMap;
101  }
102 
103  final MapFile mapFile = pathManager.getMapFile(new File(stringValue));
104  final MapControl<G, A, R> mapControl;
105  try {
106  mapControl = mapManager.openMapFile(mapFile, false);
107  } catch (final IOException ex) {
108  throw new InvalidValueException("map " + stringValue + " does not exist: " + ex.getMessage(), ex);
109  }
110  return mapControl;
111  }
112 
113  @Nullable
114  @Override
116  try {
117  return getValue();
118  } catch (final InvalidValueException ignored) {
119  return null;
120  }
121  }
122 
126  public void setValueToCurrent() {
128  }
129 
134  public boolean isCurrentMap() {
135  return getStringValue().equals(CURRENT_MAP);
136  }
137 
138 }
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.plugin.parameter.MapParameter.MapParameter
MapParameter(@NotNull final MapManager< G, A, R > mapManager, @NotNull final PathManager pathManager)
Creates a new instance.
Definition: MapParameter.java:72
net.sf.gridarta.model.mapmanager.MapManager
A MapManager manages all opened maps.
Definition: MapManager.java:37
net.sf.gridarta.model.mapcontrol.MapControl.acquire
void acquire()
Increases the use counter.
net.sf.gridarta.plugin.parameter.MapParameter.getValue
MapControl< G, A, R > getValue()
Definition: MapParameter.java:92
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.plugin.parameter.MapParameter
A PluginParameter that holds a MapControl value.
Definition: MapParameter.java:37
net.sf
net.sf.gridarta.model.io.PathManager
This class contains methods for converting relative map paths to absolute map paths and vice versa.
Definition: PathManager.java:39
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.plugin.parameter.MapParameter.mapManager
final MapManager< G, A, R > mapManager
The MapManager for converting map paths to MapControl instances.
Definition: MapParameter.java:56
net.sf.gridarta.plugin.parameter.MapParameter.isCurrentMap
boolean isCurrentMap()
Returns whether the current map is selected.
Definition: MapParameter.java:134
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.mapcontrol
Definition: DefaultMapControl.java:20
net.sf.gridarta.plugin.parameter.MapParameter.PARAMETER_TYPE
static final String PARAMETER_TYPE
The string representation of this parameter type.
Definition: MapParameter.java:43
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > >::stringValue
String stringValue
The current value.
Definition: AbstractStringPluginParameter.java:38
net.sf.gridarta.plugin.parameter.MapParameter.pathManager
final PathManager pathManager
The PathManager instance for converting Files into path names.
Definition: MapParameter.java:63
net.sf.gridarta.plugin.parameter.MapParameter.getValueOrNull
MapControl< G, A, R > getValueOrNull()
Definition: MapParameter.java:115
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > >::getStringValue
String getStringValue()
Definition: AbstractStringPluginParameter.java:50
net.sf.gridarta.plugin.parameter.MapParameter.getParameterType
String getParameterType()
Definition: MapParameter.java:80
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter
Abstract base class for PluginParameter implementations for which the value is calculated from the st...
Definition: AbstractStringPluginParameter.java:32
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.io.PathManager.getMapFile
MapFile getMapFile(@NotNull final AbsoluteMapPath mapPath)
Returns a MapFile instance from an AbsoluteMapPath.
Definition: PathManager.java:72
net.sf.gridarta.model.mapmanager.MapManager.openMapFile
MapControl< G, A, R > openMapFile(@NotNull MapFile mapFile, boolean interactive)
Loads a map file.
net.sf.gridarta.plugin.parameter.MapParameter.CURRENT_MAP
static final String CURRENT_MAP
The string representation for the current map.
Definition: MapParameter.java:49
net.sf.gridarta.plugin.parameter.InvalidValueException
An exception that is thrown if the string representation of value in a {} cannot be converted to an o...
Definition: InvalidValueException.java:30
net.sf.gridarta.model.mapmanager.MapManager.getCurrentMap
MapControl< G, A, R > getCurrentMap()
Returns the current map.
net.sf.gridarta.model.mapmodel.MapFile
The location of a map file with a map directory.
Definition: MapFile.java:31
net.sf.gridarta.model.io
Reading and writing of maps, handling of paths.
Definition: AbstractAnimationObjectsReader.java:20
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.mapcontrol.MapControl
Currently nothing more than a marker interface for unification.
Definition: MapControl.java:35
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > >::setStringValue
boolean setStringValue( @NotNull final String stringValue)
Updates the parameter value.
Definition: AbstractStringPluginParameter.java:59
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.plugin.parameter.PluginParameterVisitor
Interface for visitors of PluginParameter instances.
Definition: PluginParameterVisitor.java:32
net.sf.gridarta.plugin.parameter.MapParameter.visit
public< T > T visit(@NotNull final PluginParameterVisitor< G, A, R, T > visitor)
Definition: MapParameter.java:86
net.sf.gridarta.plugin.parameter.MapParameter.setValueToCurrent
void setValueToCurrent()
Selects the current map.
Definition: MapParameter.java:126