com.realtime.crossfire.jxclient.scripts
Interface ScriptProcess

All Superinterfaces:
java.lang.Comparable<ScriptProcess>
All Known Implementing Classes:
DefaultScriptProcess
public interface ScriptProcess
extends java.lang.Comparable<ScriptProcess>

An external command executed as a client-sided script.

Method Summary
 void addScriptProcessListener(ScriptProcessListener scriptProcessListener)
          Adds a ScriptProcessListener to be notified.
 void commandSent(java.lang.String cmd)
          Sends a message to the script process.
 java.lang.String getFilename()
          Returns the script's filename.
 int getScriptId()
          Returns the script ID identifying this script instance.
 void killScript()
          Kills the script process.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

addScriptProcessListener

void addScriptProcessListener(@NotNull
                              ScriptProcessListener scriptProcessListener)
Adds a ScriptProcessListener to be notified.

Parameters:
scriptProcessListener - the listener to add

commandSent

void commandSent(@NotNull
                 java.lang.String cmd)
Sends a message to the script process.

Parameters:
cmd - the message to send

getFilename

@NotNull
java.lang.String getFilename()
Returns the script's filename.

Returns:
the script's filename

getScriptId

int getScriptId()
Returns the script ID identifying this script instance.

Returns:
the script ID

killScript

void killScript()
Kills the script process. Does nothing if the process is not running.