Gridarta Editor
PluginParameters.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.plugin;
21 
22 import bsh.EvalError;
23 import bsh.Interpreter;
24 import java.util.HashMap;
25 import java.util.Map;
26 import java.util.Map.Entry;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29 
34 public class PluginParameters {
35 
39  @NotNull
40  private final Map<String, Object> variables = new HashMap<>();
41 
47  public void addPluginParameter(@NotNull final String name, @Nullable final Object value) {
48  variables.put(name, value);
49  }
50 
57  public void setInterpreterValues(@NotNull final Interpreter interpreter, @NotNull final PluginRunMode pluginRunMode) throws EvalError {
58  for (final Entry<String, Object> variable : variables.entrySet()) {
59  interpreter.set(variable.getKey(), variable.getValue());
60  }
61  interpreter.set("pluginRunMode", pluginRunMode);
62  }
63 
64 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.plugin.PluginParameters.addPluginParameter
void addPluginParameter(@NotNull final String name, @Nullable final Object value)
Defines a variable to be passed to plugins.
Definition: PluginParameters.java:47
net.sf.gridarta.plugin.PluginParameters
Makes basic Gridarta classes available to scripts.
Definition: PluginParameters.java:34
net.sf.gridarta.plugin.PluginParameters.variables
final Map< String, Object > variables
All defined variables for new plugins.
Definition: PluginParameters.java:40
net.sf.gridarta.plugin.PluginParameters.setInterpreterValues
void setInterpreterValues(@NotNull final Interpreter interpreter, @NotNull final PluginRunMode pluginRunMode)
Adds variables to a Interpreter instance.
Definition: PluginParameters.java:57
net.sf.gridarta.plugin.PluginRunMode
The run mode of a plugin plugin.
Definition: PluginRunMode.java:26