Gridarta Editor
ExitChecker.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.model.validation.checks;
21 
22 import java.io.IOException;
39 import net.sf.gridarta.utils.Size2D;
40 import org.jetbrains.annotations.NotNull;
41 
46 public class ExitChecker<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValidator<G, A, R> implements GameObjectValidator<G, A, R> {
47 
51  @NotNull
53 
57  private final int exitTypeNo;
58 
66  super(validatorPreferences);
67  this.mapManager = mapManager;
68  this.exitTypeNo = exitTypeNo;
69  }
70 
71  @Override
72  public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
73  if (gameObject.getTypeNo() != exitTypeNo) {
74  return;
75  }
76 
77  final String path = gameObject.getAttributeString(BaseObject.SLAYING, false);
78  if (path.length() <= 0 || path.equals("/!") || path.startsWith("/random/")) {
79  return;
80  }
81 
82  final int exitX = gameObject.getAttributeInt(BaseObject.HP);
83  final int exitY = gameObject.getAttributeInt(BaseObject.SP);
84 
85  try {
86  final MapFile mapFile = gameObject.getMapSquare().getMapModel().getMapFile(MapPathUtils.newMapPath(path));
87  try {
88  final MapControl<G, A, R> mapControl = mapManager.openMapFile(mapFile, false);
89  try {
90  final Size2D mapSize = mapControl.getMapModel().getMapArchObject().getMapSize();
91  if ((exitX != -1 || exitY != -1) && (exitX < 0 || exitX >= mapSize.getWidth() || exitY < 0 || exitY >= mapSize.getHeight())) {
92  errorCollector.collect(new ExitInvalidCoordinateError<>(gameObject, "(" + exitX + ", " + exitY + ")", mapSize));
93  }
94  } finally {
95  mapManager.release(mapControl);
96  }
97  } catch (final IOException ignored) {
98  errorCollector.collect(new ExitInvalidPathError<>(gameObject, path));
99  }
100  } catch (final SameMapException | UnsavedMapException ignored) {
101  }
102  }
103 
104 }
net.sf.gridarta.utils.Size2D.getWidth
int getWidth()
Returns the width of the area.
Definition: Size2D.java:96
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.model.mapmodel.SameMapException
Exception thrown if the destination path points to the source map.
Definition: SameMapException.java:26
net.sf.gridarta.model.validation.checks.ExitChecker.validateGameObject
void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validates a game object.
Definition: ExitChecker.java:72
net.sf.gridarta.model.mapmodel.MapModel.getMapArchObject
A getMapArchObject()
Returns the Map Arch Object with the meta information about the map.
net.sf.gridarta.model.mapmanager.MapManager
A MapManager manages all opened maps.
Definition: MapManager.java:37
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.baseobject.BaseObject.SP
String SP
The attribute name of the "sp" attribute.
Definition: BaseObject.java:96
net.sf.gridarta.model.validation.checks.ExitChecker.exitTypeNo
final int exitTypeNo
The archetype type number of exits.
Definition: ExitChecker.java:57
net.sf.gridarta.model.validation.checks.ExitChecker.ExitChecker
ExitChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final MapManager< G, A, R > mapManager, final int exitTypeNo)
Creates a new instance.
Definition: ExitChecker.java:65
net.sf
net.sf.gridarta.model.validation.checks.ExitChecker
A Validator to assert that exits are connected to maps properly.
Definition: ExitChecker.java:46
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.model.mapmodel.MapPathUtils.newMapPath
static MapPath newMapPath(@NotNull final String string)
Creates a MapPath instance from string representation.
Definition: MapPathUtils.java:43
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.mapmodel.MapPathUtils
Utility class for MapPath related functions.
Definition: MapPathUtils.java:28
net.sf.gridarta.model.mapcontrol
Definition: DefaultMapControl.java:20
net.sf.gridarta.model.validation.AbstractValidator.validatorPreferences
final ValidatorPreferences validatorPreferences
The ValidatorPreferences to use.
Definition: AbstractValidator.java:55
net.sf.gridarta.model.validation.ValidatorPreferences
Configuration parameters for Validators.
Definition: ValidatorPreferences.java:28
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.utils.Size2D.getHeight
int getHeight()
Returns the height of the area.
Definition: Size2D.java:104
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapmanager.MapManager.openMapFile
MapControl< G, A, R > openMapFile(@NotNull MapFile mapFile, boolean interactive)
Loads a map file.
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.model.validation.AbstractValidator
This is the base class for validators.
Definition: AbstractValidator.java:37
net.sf.gridarta.model.mapmodel.UnsavedMapException
Exception thrown if an operation is attempted on an unsaved map.
Definition: UnsavedMapException.java:26
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.baseobject.BaseObject.SLAYING
String SLAYING
The name of the "slaying" attribute.
Definition: BaseObject.java:120
net.sf.gridarta.model.baseobject.BaseObject
Definition: BaseObject.java:34
net.sf.gridarta.model.mapmodel.MapFile
The location of a map file with a map directory.
Definition: MapFile.java:31
net.sf.gridarta.model.mapmanager.MapManager.release
void release(@NotNull MapControl< G, A, R > mapControl)
Releases a MapControl instance.
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.baseobject
Definition: AbstractBaseObject.java:20
net.sf.gridarta.model.validation.checks.ExitChecker.mapManager
final MapManager< G, A, R > mapManager
The MapManager for loading maps.
Definition: ExitChecker.java:52
net.sf.gridarta.model.validation.GameObjectValidator
Interface for GameObject Validators.
Definition: GameObjectValidator.java:32
net.sf.gridarta.model.mapcontrol.MapControl
Currently nothing more than a marker interface for unification.
Definition: MapControl.java:35
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.mapcontrol.MapControl.getMapModel
MapModel< G, A, R > getMapModel()
Returns the map model.
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.baseobject.BaseObject.HP
String HP
The attribute name of the "hp" attribute.
Definition: BaseObject.java:90
net.sf.gridarta.model.validation.errors.ExitInvalidPathError
Validation error that's used when a map has wrong exit paths.
Definition: ExitInvalidPathError.java:32
net.sf.gridarta.utils.Size2D
The class Size2D represents a 2d rectangular area.
Definition: Size2D.java:30
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.model.validation.errors.ExitInvalidCoordinateError
Validation error that's used when an exit points to an invalid position.
Definition: ExitInvalidCoordinateError.java:32