Gridarta Editor
InsertionModeSet.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.mapmodel;
21 
26 import org.jetbrains.annotations.NotNull;
27 import org.jetbrains.annotations.Nullable;
28 
33 public class InsertionModeSet<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
34 
38  @NotNull
40 
44  @NotNull
46 
50  @NotNull
52 
56  @NotNull
58 
62  @NotNull
64 
77  public InsertionModeSet(@NotNull final InsertionMode topmostInsertionMode, @Nullable final GameObjectMatcher floorGameObjectMatcher, @Nullable final GameObjectMatcher wallGameObjectMatcher, @Nullable final GameObjectMatcher belowFloorGameObjectMatcher, @Nullable final GameObjectMatcher systemObjectGameObjectMatcher) {
78  this.topmostInsertionMode = topmostInsertionMode;
79  autoInsertionMode = new AutoInsertionMode(floorGameObjectMatcher, wallGameObjectMatcher, belowFloorGameObjectMatcher, systemObjectGameObjectMatcher);
80  aboveFloorInsertionMode = new AboveFloorInsertionMode(floorGameObjectMatcher);
81  belowFloorInsertionMode = new BelowFloorInsertionMode(floorGameObjectMatcher);
82  }
83 
88  @NotNull
90  return autoInsertionMode;
91  }
92 
97  @NotNull
99  return topmostInsertionMode;
100  }
101 
106  @NotNull
109  }
110 
115  @NotNull
118  }
119 
124  @NotNull
127  }
128 
129 }
net.sf.gridarta.model.mapmodel.InsertionModeSet.getTopmostInsertionMode
InsertionMode getTopmostInsertionMode()
Returns the "topmost" insertion mode.
Definition: InsertionModeSet.java:98
net.sf.gridarta.model.mapmodel.InsertionModeSet
A set of InsertionModes.
Definition: InsertionModeSet.java:33
net.sf.gridarta.model.mapmodel.InsertionModeSet.topmostInsertionMode
final InsertionMode topmostInsertionMode
The "topmost" insertion mode.
Definition: InsertionModeSet.java:45
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.mapmodel.InsertionModeSet.aboveFloorInsertionMode
final InsertionMode aboveFloorInsertionMode
The "above floor" insertion mode.
Definition: InsertionModeSet.java:51
net.sf.gridarta.model.mapmodel.BelowFloorInsertionMode
Insert right below the bottommost floor square.
Definition: BelowFloorInsertionMode.java:34
net.sf
net.sf.gridarta.model.mapmodel.BottommostInsertionMode
Insert bottommost.
Definition: BottommostInsertionMode.java:31
net.sf.gridarta.model.mapmodel.InsertionModeSet.bottommostInsertionMode
final InsertionMode bottommostInsertionMode
The "bottommost" insertion mode.
Definition: InsertionModeSet.java:63
net.sf.gridarta.model.match.GameObjectMatcher
Interface for classes that match GameObjects.
Definition: GameObjectMatcher.java:30
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.InsertionModeSet.getBelowFloorInsertionMode
InsertionMode getBelowFloorInsertionMode()
Returns the "below floor" insertion mode.
Definition: InsertionModeSet.java:116
net.sf.gridarta.model.mapmodel.InsertionModeSet.getAutoInsertionMode
InsertionMode getAutoInsertionMode()
Returns the "auto" insertion mode.
Definition: InsertionModeSet.java:89
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.match
Classes related to matching {GameObjects}, so called { net.sf.gridarta.model.match....
Definition: AndGameObjectMatcher.java:20
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapmodel.AutoInsertionMode
Automatically guess the insertion position.
Definition: AutoInsertionMode.java:35
net.sf.gridarta.model.mapmodel.InsertionModeSet.belowFloorInsertionMode
final InsertionMode belowFloorInsertionMode
The "below floor" insertion mode.
Definition: InsertionModeSet.java:57
net.sf.gridarta.model.mapmodel.InsertionModeSet.getBottommostInsertionMode
InsertionMode getBottommostInsertionMode()
Returns the "bottommost" insertion mode.
Definition: InsertionModeSet.java:125
net.sf.gridarta.model.mapmodel.InsertionMode
Insertion modes.
Definition: InsertionMode.java:33
net.sf.gridarta.model.mapmodel.AboveFloorInsertionMode
Insert right above the topmost floor square.
Definition: AboveFloorInsertionMode.java:34
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.mapmodel.InsertionModeSet.getAboveFloorInsertionMode
InsertionMode getAboveFloorInsertionMode()
Returns the "above floor" insertion mode.
Definition: InsertionModeSet.java:107
net.sf.gridarta.model.mapmodel.InsertionModeSet.autoInsertionMode
final InsertionMode autoInsertionMode
The "auto" insertion mode.
Definition: InsertionModeSet.java:39
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.mapmodel.InsertionModeSet.InsertionModeSet
InsertionModeSet(@NotNull final InsertionMode topmostInsertionMode, @Nullable final GameObjectMatcher floorGameObjectMatcher, @Nullable final GameObjectMatcher wallGameObjectMatcher, @Nullable final GameObjectMatcher belowFloorGameObjectMatcher, @Nullable final GameObjectMatcher systemObjectGameObjectMatcher)
Creates a new instance.
Definition: InsertionModeSet.java:77