Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.scripts.ScriptManager Class Reference

Crossfire JXClient, Trunk

Collaboration diagram for com.realtime.crossfire.jxclient.scripts.ScriptManager:

Collaboration graph

Public Member Functions
Set< ScriptProcess >	getScripts (@NotNull final String partialScriptName)

boolean	hasScripts ()

void	newScript (@NotNull final String command)

	ScriptManager (@NotNull final CommandQueue commandQueue, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final Stats stats, @NotNull final FloorView floorView, @NotNull final ItemSet itemSet, @NotNull final SpellsManager spellsManager, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final SkillSet skillSet)

Private Member Functions
Set< ScriptProcess >	getScriptByScriptId (final int scriptId)

Set< ScriptProcess >	getScriptsByName (@NotNull final CharSequence partialScriptName)

Private Attributes
final CommandQueue	commandQueue

final CrossfireServerConnection	crossfireServerConnection

final FloorView	floorView

final ItemSet	itemSet

final MapUpdaterState	mapUpdaterState

int	nextScriptId = 1

final Collection< ScriptProcess >	scriptProcesses = new CopyOnWriteArraySet<>()

final SkillSet	skillSet

final SpellsManager	spellsManager

final Stats	stats

Detailed Description

Maintains currently running script processes.

Author: Andreas Kirschbaum

Definition at line 46 of file ScriptManager.java.

Constructor & Destructor Documentation

◆ ScriptManager()

com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager	(	@NotNull final CommandQueue	commandQueue,
		@NotNull final CrossfireServerConnection	crossfireServerConnection,
		@NotNull final Stats	stats,
		@NotNull final FloorView	floorView,
		@NotNull final ItemSet	itemSet,
		@NotNull final SpellsManager	spellsManager,
		@NotNull final MapUpdaterState	mapUpdaterState,
		@NotNull final SkillSet	skillSet
	)

Creates a new instance.

Parameters

commandQueue	the command queue for sending commands
crossfireServerConnection	the connection instance
stats	the stats instance to watch
floorView	the floor view to use
itemSet	the item set instance to use
spellsManager	the spells manager instance to use
mapUpdaterState	the map updater state instance to use
skillSet	the skill set for looking up skill names

Definition at line 118 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.ScriptManager.commandQueue, com.realtime.crossfire.jxclient.scripts.ScriptManager.crossfireServerConnection, com.realtime.crossfire.jxclient.scripts.ScriptManager.floorView, com.realtime.crossfire.jxclient.scripts.ScriptManager.itemSet, com.realtime.crossfire.jxclient.scripts.ScriptManager.mapUpdaterState, com.realtime.crossfire.jxclient.scripts.ScriptManager.skillSet, com.realtime.crossfire.jxclient.scripts.ScriptManager.spellsManager, and com.realtime.crossfire.jxclient.scripts.ScriptManager.stats.

Member Function Documentation

◆ getScriptByScriptId()

Set<ScriptProcess> com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptByScriptId ( final int scriptId )

private

Returns all running scripts matching a given script ID.

Parameters

scriptId the script ID

Returns: the matching scripts, possibly empty

Definition at line 177 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.ScriptManager.scriptProcesses.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.getScripts().

Here is the caller graph for this function:

◆ getScripts()

Set<ScriptProcess> com.realtime.crossfire.jxclient.scripts.ScriptManager.getScripts ( @NotNull final String partialScriptName )

Returns all running scripts matching a given (partial) name or a script ID.

Parameters

partialScriptName the partial name or a script ID to match against; an empty string matches all scripts

Returns: the matching scripts, possibly empty

Definition at line 163 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptByScriptId(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptsByName().

Referenced by com.realtime.crossfire.jxclient.commands.ScriptkillCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptkillallCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptsCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScripttellCommand.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScriptsByName()

Set<ScriptProcess> com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptsByName ( @NotNull final CharSequence partialScriptName )

private

Returns all running scripts matching a given (partial) name.

Parameters

partialScriptName the partial script name; an empty string matches all scripts

Returns: the matching scripts, possibly empty

Definition at line 195 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.ScriptManager.scriptProcesses.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.getScripts().

Here is the caller graph for this function:

◆ hasScripts()

boolean com.realtime.crossfire.jxclient.scripts.ScriptManager.hasScripts ( )

Returns whether at least one script is running.

Returns: whether at least one script is running

Definition at line 203 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.ScriptManager.scriptProcesses.

Referenced by com.realtime.crossfire.jxclient.commands.ScriptkillCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptkillallCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptsCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScripttellCommand.execute().

Here is the caller graph for this function:

◆ newScript()

void com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript ( @NotNull final String command )

Creates a new script instance.

Parameters

command the script command including arguments

Definition at line 133 of file ScriptManager.java.

References com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.addScriptProcessListener(), com.realtime.crossfire.jxclient.scripts.ScriptManager.commandQueue, com.realtime.crossfire.jxclient.scripts.ScriptManager.crossfireServerConnection, com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.drawInfo(), com.realtime.crossfire.jxclient.scripts.ScriptManager.floorView, com.realtime.crossfire.jxclient.scripts.ScriptManager.itemSet, com.realtime.crossfire.jxclient.scripts.ScriptManager.mapUpdaterState, com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener.NDI_BLACK, com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener.NDI_RED, com.realtime.crossfire.jxclient.scripts.ScriptManager.nextScriptId, com.realtime.crossfire.jxclient.scripts.ScriptManager.scriptProcesses, com.realtime.crossfire.jxclient.scripts.ScriptManager.skillSet, com.realtime.crossfire.jxclient.scripts.ScriptManager.spellsManager, and com.realtime.crossfire.jxclient.scripts.ScriptManager.stats.

Referenced by com.realtime.crossfire.jxclient.commands.ScriptCommand.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ commandQueue

final CommandQueue com.realtime.crossfire.jxclient.scripts.ScriptManager.commandQueue

private

The CommandQueue for sending commands.

Definition at line 52 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ crossfireServerConnection

final CrossfireServerConnection com.realtime.crossfire.jxclient.scripts.ScriptManager.crossfireServerConnection

private

The CrossfireServerConnection instance.

Definition at line 58 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ floorView

final FloorView com.realtime.crossfire.jxclient.scripts.ScriptManager.floorView

private

The FloorView to use.

Definition at line 70 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ itemSet

final ItemSet com.realtime.crossfire.jxclient.scripts.ScriptManager.itemSet

private

The ItemSet instance to use.

Definition at line 76 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ mapUpdaterState

final MapUpdaterState com.realtime.crossfire.jxclient.scripts.ScriptManager.mapUpdaterState

private

The MapUpdaterState instance to use.

Definition at line 88 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ nextScriptId

int com.realtime.crossfire.jxclient.scripts.ScriptManager.nextScriptId = 1

private

The script ID for the next created script.

Definition at line 105 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript().

◆ scriptProcesses

final Collection<ScriptProcess> com.realtime.crossfire.jxclient.scripts.ScriptManager.scriptProcesses = new CopyOnWriteArraySet<>()

private

All running ScriptProcesses.

Definition at line 100 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptByScriptId(), com.realtime.crossfire.jxclient.scripts.ScriptManager.getScriptsByName(), com.realtime.crossfire.jxclient.scripts.ScriptManager.hasScripts(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript().

◆ skillSet

final SkillSet com.realtime.crossfire.jxclient.scripts.ScriptManager.skillSet

private

The SkillSet for looking up skill names.

Definition at line 94 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ spellsManager

final SpellsManager com.realtime.crossfire.jxclient.scripts.ScriptManager.spellsManager

private

The spells manager instance to use.

Definition at line 82 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

◆ stats

final Stats com.realtime.crossfire.jxclient.scripts.ScriptManager.stats

private

The Stats instance to watch.

Definition at line 64 of file ScriptManager.java.

Referenced by com.realtime.crossfire.jxclient.scripts.ScriptManager.newScript(), and com.realtime.crossfire.jxclient.scripts.ScriptManager.ScriptManager().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/scripts/ScriptManager.java