Class ScriptConfig
java.lang.Object
com.inductiveautomation.ignition.common.script.ScriptConfig
- Direct Known Subclasses:
ClientScriptConfig
,PerspectiveGatewayEventsConfig
,SystemEventsConfig
This class is simply a storage class for the serialization of various script configuration things. An instance of
this class is held by the root FPMIApp and it stores things like the startup and shutdown scripts, the keystroke
scripts, and the timer scripts.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final record
Configuration resource for message handler scripts.static final record
Configuration resource for shutdown scripts.static final record
Configuration resource for startup scripts.static final record
Configuration resource for tag change scripts.static final record
Configuration resource for timer scripts. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final String
static final String
protected Map<MessageHandlerKey,
String> static final String
static final ResourceType
static final String
protected List<com.inductiveautomation.ignition.common.script.ScheduledScript>
static final String
protected String
static final String
protected String
static final String
protected List<TagChangeScript>
static final String
protected String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCollects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its correspondingResourcePath
andResourceBuilder
.List<com.inductiveautomation.ignition.common.script.ScheduledScript>
void
void
setScheduledScripts
(List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts) void
setShutdownScript
(String string) void
setStartupScript
(String string) void
setTagChangeScripts
(List<TagChangeScript> scripts) void
setTagChangeScripts
(Map<String, String> oldMap) Deprecated.void
setTimerScripts
(Map<TimerKey, String> map) void
setUpdateScript
(String updateScript)
-
Field Details
-
RESOURCE_TYPE
-
STARTUP_LOCATION_VALUE
- See Also:
-
SHUTDOWN_LOCATION_VALUE
- See Also:
-
PROJECT_UPDATE_VALUE
- See Also:
-
TAG_CHANGE_VALUE
- See Also:
-
TIMER_SCRIPT_VALUE
- See Also:
-
SCHEDULED_SCRIPT_VALUE
- See Also:
-
MESSAGE_SCRIPT_VALUE
- See Also:
-
startupScript
-
shutdownScript
-
updateScript
-
timerScripts
-
messageHandlerScripts
-
tagChangeScripts
-
scheduledScripts
-
ENABLED_KEY
- See Also:
-
-
Constructor Details
-
ScriptConfig
public ScriptConfig()
-
-
Method Details
-
getShutdownScript
-
getStartupScript
-
setShutdownScript
-
setStartupScript
-
getUpdateScript
-
setUpdateScript
-
getTimerScripts
-
setTimerScripts
-
getMessageHandlerScripts
-
setMessageHandlerScripts
-
setTagChangeScripts
Deprecated. -
getTagChangeScripts
-
setScheduledScripts
public void setScheduledScripts(List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts) -
getScheduledScripts
@Nonnull public List<com.inductiveautomation.ignition.common.script.ScheduledScript> getScheduledScripts() -
setTagChangeScripts
-
collectMigrationScriptMappings
Collects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its correspondingResourcePath
andResourceBuilder
. The resulting map contains builders to construct and serialize these scripts into resources on disk
-