Gridarta Editor
UndefinedFaceChecker.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 
32 import org.jetbrains.annotations.NotNull;
33 
38 public class UndefinedFaceChecker<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> {
39 
45  super(validatorPreferences);
46  }
47 
48  @Override
49  public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
50  if (gameObject.getFaceObjSource() == FaceSource.FACE_NOT_FOUND) {
51  final String animName = gameObject.getAnimName();
52  if (animName != null && !animName.equals("NONE")) {
53  errorCollector.collect(new UndefinedAnimError<>(gameObject, animName));
54  } else {
55  final String faceName = gameObject.getFaceName();
56  if (faceName != null) {
57  errorCollector.collect(new UndefinedFaceError<>(gameObject, faceName));
58  }
59  }
60  }
61  }
62 
63 }
net.sf.gridarta.model.gameobject.FaceSource
Enumeration describing the state of the face.
Definition: FaceSource.java:28
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.checks.UndefinedFaceChecker.UndefinedFaceChecker
UndefinedFaceChecker(@NotNull final ValidatorPreferences validatorPreferences)
Creates a new instance.
Definition: UndefinedFaceChecker.java:44
net.sf
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.validation.errors.UndefinedAnimError
A GameObjectValidationError indicating a game object references an undefined animation.
Definition: UndefinedAnimError.java:33
net.sf.gridarta.model.validation.checks.UndefinedFaceChecker
Checks that a game object does not reference an undefined face.
Definition: UndefinedFaceChecker.java:38
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.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.model.validation.errors.UndefinedFaceError
A GameObjectValidationError indicating a game object references an undefined face.
Definition: UndefinedFaceError.java:33
net.sf.gridarta.model.validation.AbstractValidator
This is the base class for validators.
Definition: AbstractValidator.java:37
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.checks.UndefinedFaceChecker.validateGameObject
void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validates a game object.
Definition: UndefinedFaceChecker.java:49
net.sf.gridarta.model.validation.GameObjectValidator
Interface for GameObject Validators.
Definition: GameObjectValidator.java:32
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.gameobject.FaceSource.FACE_NOT_FOUND
FACE_NOT_FOUND
The face of this GameObject was not found.
Definition: FaceSource.java:33