Gridarta Editor
FileControl.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.mapmanager;
21 
22 import java.io.File;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29 
30 public interface FileControl<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
31 
37  void openFile(boolean mapFile);
38 
44  boolean save(@NotNull MapControl<G, A, R> mapControl);
45 
49  void saveAllMaps();
50 
55  boolean closeAllMaps();
56 
63  boolean saveAs(@NotNull MapControl<G, A, R> mapControl);
64 
71  boolean confirmSaveChanges(@NotNull MapControl<G, A, R> mapControl);
72 
78  void reportSaveError(@NotNull MapControl<G, A, R> mapControl, @NotNull String message);
79 
85  void reportSaveError(@NotNull File mapFile, @NotNull String message);
86 
87  void reportLoadError(@Nullable File file, @NotNull String message);
88 
89  void reportOutOfMapBoundsDeleted(@NotNull File file, int outOfMapBoundsDeleted, @NotNull StringBuilder outOfMapBoundsObjects);
90 
91  void reportOutOfMemory(@NotNull File file);
92 
98  void reportTeleportCharacterError(@NotNull String mapPath, @NotNull String message);
99 
100 }
net.sf.gridarta.model.mapmanager.FileControl.openFile
void openFile(boolean mapFile)
The user wants to edit a file.
net.sf.gridarta.model.mapmanager.FileControl.reportOutOfMapBoundsDeleted
void reportOutOfMapBoundsDeleted(@NotNull File file, int outOfMapBoundsDeleted, @NotNull StringBuilder outOfMapBoundsObjects)
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.mapmanager.FileControl.reportOutOfMemory
void reportOutOfMemory(@NotNull File file)
net.sf.gridarta.model.mapmanager.FileControl
Definition: FileControl.java:30
net.sf.gridarta.model.mapmanager.FileControl.saveAs
boolean saveAs(@NotNull MapControl< G, A, R > mapControl)
Asks the user for a filename, then saves the map.
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.mapmanager.FileControl.reportLoadError
void reportLoadError(@Nullable File file, @NotNull String message)
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.model.mapmanager.FileControl.saveAllMaps
void saveAllMaps()
Saves all maps.
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.mapmanager.FileControl.confirmSaveChanges
boolean confirmSaveChanges(@NotNull MapControl< G, A, R > mapControl)
Asks the user whether to save changes of a map.
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapmanager.FileControl.reportSaveError
void reportSaveError(@NotNull MapControl< G, A, R > mapControl, @NotNull String message)
Reports an error while saving a map file to the user.
net.sf.gridarta.model.mapmanager.FileControl.reportTeleportCharacterError
void reportTeleportCharacterError(@NotNull String mapPath, @NotNull String message)
Reports an error while teleporting a character to the current map.
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.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.mapmanager.FileControl.save
boolean save(@NotNull MapControl< G, A, R > mapControl)
Save one map.
net.sf.gridarta.model.mapmanager.FileControl.closeAllMaps
boolean closeAllMaps()
Invoked when the user wants to close all maps.