Gridarta Editor
NonAbsoluteExitPathChecker.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.var.crossfire.model.validation.checks;
21 
37 import org.jetbrains.annotations.NotNull;
38 
45 public class NonAbsoluteExitPathChecker extends AbstractValidator<GameObject, MapArchObject, Archetype> implements GameObjectValidator<GameObject, MapArchObject, Archetype> {
46 
50  @NotNull
52 
60  super(validatorPreferences);
61  this.exitGameObjectMatcher = exitGameObjectMatcher;
62  }
63 
64  @Override
65  public void validateGameObject(@NotNull final GameObject gameObject, @NotNull final ErrorCollector<GameObject, MapArchObject, Archetype> errorCollector) {
66  if (!exitGameObjectMatcher.isMatching(gameObject)) {
67  return; // not an exit => skip
68  }
69 
71  if (mapSquare == null) {
72  return; // not on a map => skip
73  }
74 
76  final MapArchObject mapArchObject = mapModel.getMapArchObject();
77  if (!mapArchObject.isUnique()) {
78  return; // not on an unique map => skip
79  }
80 
81  final MapPath exitPath;
82  try {
83  exitPath = MapLocation.getMapPath(gameObject, true);
84  } catch (final NoExitPathException ignored) {
85  return; // unset exit path => skip
86  }
87  if (exitPath instanceof AbsoluteMapPath) {
88  return; // absolute exit path => ok
89  }
90 
91  errorCollector.collect(new NonAbsoluteExitPathError<>(gameObject, exitPath));
92  }
93 
94 }
net.sf.gridarta.model.maplocation.MapLocation.getMapPath
MapPath getMapPath()
Returns the map path.
Definition: MapLocation.java:116
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
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.mapmodel.MapSquare.getMapSquareOptional
MapSquare< G, A, R > getMapSquareOptional()
Returns the MapSquare this game object is part of.
Definition: MapSquare.java:156
net.sf.gridarta.model.mapmodel.AbsoluteMapPath
A MapPath that is absolute, that is, it starts with a "/".
Definition: AbsoluteMapPath.java:29
net.sf.gridarta.var.crossfire.model.archetype
Definition: Archetype.java:20
net.sf.gridarta.model.validation.checks.NonAbsoluteExitPathError
A GameObjectValidationError that describes an exit GameObject having an invalid exit path.
Definition: NonAbsoluteExitPathError.java:35
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.var.crossfire.model.validation.checks.NonAbsoluteExitPathChecker.validateGameObject
void validateGameObject(@NotNull final GameObject gameObject, @NotNull final ErrorCollector< GameObject, MapArchObject, Archetype > errorCollector)
Definition: NonAbsoluteExitPathChecker.java:65
net.sf
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.model.match.GameObjectMatcher
Interface for classes that match GameObjects.
Definition: GameObjectMatcher.java:30
net.sf.gridarta.var
net.sf.gridarta.model.match.GameObjectMatcher.isMatching
boolean isMatching(@NotNull GameObject<?, ?, ?> gameObject)
Matches a GameObject.
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
net.sf.gridarta.var.crossfire.model.archetype.Archetype
Implements Crossfire archetypes.
Definition: Archetype.java:30
net.sf.gridarta.var.crossfire.model.maparchobject.MapArchObject
MapArchObject contains the specific meta data about a map that is stored in the map-arch,...
Definition: MapArchObject.java:39
net.sf.gridarta.model.match
Classes related to matching {GameObjects}, so called { net.sf.gridarta.model.match....
Definition: AndGameObjectMatcher.java:20
net.sf.gridarta.var.crossfire
Main package of Gridarta4Crossfire, contains all classes specific to the Crossfire version of the Gri...
net.sf.gridarta.model.maplocation.NoExitPathException
Exception thrown if a game object does not specify a valid exit path.
Definition: NoExitPathException.java:29
net.sf.gridarta.var.crossfire.model
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.MapPath
Represents a maps directory local map path.
Definition: MapPath.java:31
net.sf.gridarta.model.maplocation.MapLocation
Represents a location on a map consisting of a map path and a map coordinate.
Definition: MapLocation.java:42
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.mapmodel.MapSquare.getMapModel
MapModel< G, A, R > getMapModel()
Returns the MapModel this map square is part of.
Definition: MapSquare.java:99
net.sf.gridarta.model.validation.checks
This package contains the checks for validating maps.
Definition: AbstractShopSquareChecker.java:20
net.sf.gridarta.model
net.sf.gridarta.var.crossfire.model.maparchobject
Definition: DefaultMapArchObjectFactory.java:20
net.sf.gridarta.var.crossfire.model.gameobject
Handles the Crossfire variants of GameObjects and Archetypes.
Definition: DefaultGameObjectFactory.java:20
net.sf.gridarta.var.crossfire.model.validation.checks.NonAbsoluteExitPathChecker.NonAbsoluteExitPathChecker
NonAbsoluteExitPathChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final GameObjectMatcher exitGameObjectMatcher)
Creates a new instance.
Definition: NonAbsoluteExitPathChecker.java:59
net.sf.gridarta.var.crossfire.model.validation.checks.NonAbsoluteExitPathChecker.exitGameObjectMatcher
final GameObjectMatcher exitGameObjectMatcher
The GameObjectMatcher for matching exit objects.
Definition: NonAbsoluteExitPathChecker.java:51
net.sf.gridarta.var.crossfire.model.gameobject.GameObject
Handles the Crossfire GameObjects.
Definition: GameObject.java:41
net.sf.gridarta.model.validation.GameObjectValidator
Interface for GameObject Validators.
Definition: GameObjectValidator.java:32
net.sf.gridarta.var.crossfire.model.maparchobject.MapArchObject.isUnique
boolean isUnique()
Get whether this map is unique.
Definition: MapArchObject.java:231
net.sf.gridarta.model.maplocation
Definition: MapLocation.java:20
net.sf.gridarta.var.crossfire.model.validation.checks.NonAbsoluteExitPathChecker
A net.sf.gridarta.model.validation.MapValidator that checks for relative exit paths within unique map...
Definition: NonAbsoluteExitPathChecker.java:45