Gridarta Editor
ExitConnectorModel.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.exitconnector;
21 
22 import org.jetbrains.annotations.NotNull;
23 import org.jetbrains.annotations.Nullable;
24 
29 public interface ExitConnectorModel {
30 
34  boolean PASTE_EXIT_NAME_DEFAULT = true;
35 
39  boolean AUTO_CREATE_EXIT_DEFAULT = true;
40 
44  String EXIT_ARCHETYPE_NAME_DEFAULT = "invis_exit";
45 
50  @Nullable
52 
57  void setExitLocation(@Nullable ExitLocation exitLocation);
58 
63  boolean isPasteExitName();
64 
69  void setPasteExitName(boolean pasteExitName);
70 
75  boolean isAutoCreateExit();
76 
82  void setAutoCreateExit(boolean autoCreateExit);
83 
88  @NotNull
89  String getExitArchetypeName();
90 
95  void setExitArchetypeName(@NotNull String exitArchetypeName);
96 
102 
108 
109 }
net.sf.gridarta.model.exitconnector.ExitConnectorModel.AUTO_CREATE_EXIT_DEFAULT
boolean AUTO_CREATE_EXIT_DEFAULT
The default value for isAutoCreateExit().
Definition: ExitConnectorModel.java:39
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setExitArchetypeName
void setExitArchetypeName(@NotNull String exitArchetypeName)
Sets the archetype name for creating exit game objects.
net.sf.gridarta.model.exitconnector.ExitLocation
Stores information about a remembered exit location.
Definition: ExitLocation.java:35
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setPasteExitName
void setPasteExitName(boolean pasteExitName)
Sets whether the exit name should be updated.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.PASTE_EXIT_NAME_DEFAULT
boolean PASTE_EXIT_NAME_DEFAULT
The default value for isPasteExitName().
Definition: ExitConnectorModel.java:34
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setExitLocation
void setExitLocation(@Nullable ExitLocation exitLocation)
Sets the remembered exit location.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.removeExitConnectorModelListener
void removeExitConnectorModelListener(@NotNull ExitConnectorModelListener listener)
Removes an ExitConnectorModelListener to be notified of changes.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.addExitConnectorModelListener
void addExitConnectorModelListener(@NotNull ExitConnectorModelListener listener)
Adds an ExitConnectorModelListener to be notified of changes.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.EXIT_ARCHETYPE_NAME_DEFAULT
String EXIT_ARCHETYPE_NAME_DEFAULT
The default value for getExitArchetypeName().
Definition: ExitConnectorModel.java:44
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setAutoCreateExit
void setAutoCreateExit(boolean autoCreateExit)
Sets whether exit game objects should be auto-created when needed.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.getExitArchetypeName
String getExitArchetypeName()
Returns the archetype name when creating exit game objects.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.isAutoCreateExit
boolean isAutoCreateExit()
Returns whether exit game objects should be auto-created when needed.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.getExitLocation
ExitLocation getExitLocation()
Returns the remembered exit location.
net.sf.gridarta.model.exitconnector.ExitConnectorModel
Stores information needed by the exit connector.
Definition: ExitConnectorModel.java:29
net.sf.gridarta.model.exitconnector.ExitConnectorModelListener
Interface for listeners interested in ExitConnectorModel related events.
Definition: ExitConnectorModelListener.java:31
net.sf.gridarta.model.exitconnector.ExitConnectorModel.isPasteExitName
boolean isPasteExitName()
Returns whether the exit name should be updated.