com.realtime.crossfire.jxclient.scripts

Interface ScriptProcess

All Superinterfaces:

java.lang.Comparable<ScriptProcess>

All Known Implementing Classes:

AbstractScriptProcess, DefaultScriptProcess

public interface ScriptProcess
extends java.lang.Comparable<ScriptProcess>

An external command executed as a client-sided script.

Method Summary

Modifier and Type	Method and Description
void	addScriptProcessListener(@NotNull ScriptProcessListener scriptProcessListener) Adds a ScriptProcessListener to be notified.
void	commandSent(@NotNull java.lang.String cmd) Sends a message to the script process.
@NotNull 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

getScriptId

int getScriptId()

Returns the script ID identifying this script instance.

Returns:

the script ID

getFilename

@NotNull
@NotNull java.lang.String getFilename()

Returns the script's filename.

Returns:

the script's filename

commandSent

void commandSent(@NotNull
                 @NotNull java.lang.String cmd)

Sends a message to the script process.

Parameters:

cmd - the message to send

addScriptProcessListener

void addScriptProcessListener(@NotNull
                              @NotNull ScriptProcessListener scriptProcessListener)

Adds a ScriptProcessListener to be notified.

Parameters:

scriptProcessListener - the listener to add

killScript

void killScript()

Kills the script process. Does nothing if the process is not running.