A PluginParameter that holds a MapControl value. More...
Inheritance diagram for net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Collaboration diagram for net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Public Member Functions | |
| String | getParameterType () |
| MapControl< G, A, R > | getValue () throws InvalidValueException |
| MapControl< G, A, R > | getValueOrNull () |
| boolean | isCurrentMap () |
| Returns whether the current map is selected. More... | |
| MapParameter (@NotNull final MapManager< G, A, R > mapManager, @NotNull final PathManager pathManager) | |
| Creates a new instance. More... | |
| void | setValueToCurrent () |
| Selects the current map. More... | |
| Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > > | |
| String | getStringValue () |
| boolean | setStringValue ( @NotNull final String stringValue) |
| Updates the parameter value. More... | |
Static Public Attributes | |
| static final String | PARAMETER_TYPE = MapControl.class.getName() |
| The string representation of this parameter type. More... | |
Private Attributes | |
| final MapManager< G, A, R > | mapManager |
| The MapManager for converting map paths to MapControl instances. More... | |
| final PathManager | pathManager |
| The PathManager instance for converting Files into path names. More... | |
Static Private Attributes | |
| static final String | CURRENT_MAP = "[Current Map]" |
| The string representation for the current map. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > > | |
| AbstractStringPluginParameter ( @NotNull final String stringValue) | |
| Creates a new instance. More... | |
Detailed Description
A PluginParameter that holds a MapControl value.
Definition at line 37 of file MapParameter.java.
Constructor & Destructor Documentation
◆ MapParameter()
| net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapParameter | ( | @NotNull final MapManager< G, A, R > | mapManager, |
| @NotNull final PathManager | pathManager | ||
| ) |
Creates a new instance.
- Parameters
-
mapManager the map manager for converting map paths to map control instances pathManager the path manager instance for converting files into path names
Definition at line 72 of file MapParameter.java.
References net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapManager, and net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pathManager.
Member Function Documentation
◆ getParameterType()
| String net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType | ( | ) |
◆ getValue()
| MapControl<G, A, R> net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValue | ( | ) | throws InvalidValueException |
Definition at line 92 of file MapParameter.java.
References net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.acquire(), net.sf.gridarta.model.mapmanager.MapManager< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getCurrentMap(), net.sf.gridarta.model.io.PathManager.getMapFile(), net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > >.getStringValue(), net.sf.gridarta.model.mapmanager.MapManager< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.openMapFile(), and net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, MapControl< G, A, R > >.stringValue.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getValueOrNull()
| MapControl<G, A, R> net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValueOrNull | ( | ) |
Definition at line 115 of file MapParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapFromXml3().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isCurrentMap()
| boolean net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isCurrentMap | ( | ) |
Returns whether the current map is selected.
- Returns
- whether the current map is selected
Definition at line 134 of file MapParameter.java.
Here is the call graph for this function:
◆ setValueToCurrent()
| void net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setValueToCurrent | ( | ) |
Selects the current map.
Definition at line 126 of file MapParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapToXml2().
Here is the call graph for this function:
Here is the caller graph for this function:
Member Data Documentation
◆ CURRENT_MAP
|
staticprivate |
The string representation for the current map.
Definition at line 49 of file MapParameter.java.
◆ mapManager
|
private |
The MapManager for converting map paths to MapControl instances.
Definition at line 56 of file MapParameter.java.
◆ PARAMETER_TYPE
|
static |
The string representation of this parameter type.
Definition at line 43 of file MapParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.createParameter(), net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType(), and net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.getTypes().
◆ pathManager
|
private |
The PathManager instance for converting Files into path names.
Definition at line 63 of file MapParameter.java.
The documentation for this class was generated from the following file:
- gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/MapParameter.java
