com.realtime.crossfire.jxclient.gui.commands
Interface CommandCallback

All Known Implementing Classes:
GuiManagerCommandCallback
public interface CommandCallback

Interface that defines callback functions needed by commands.

Method Summary
 void accountCreate(java.lang.String login, java.lang.String password)
          Creates an account.
 void accountCreateCharacter(java.lang.String login)
          Creates a character.
 void accountLink(int force, java.lang.String login, java.lang.String password)
          Links a character to the current account.
 void accountLogin(java.lang.String login, java.lang.String password)
          Login to an account.
 void accountPlayCharacter(java.lang.String name)
          Plays a character from the current account.
 void activateCommandInput(java.lang.String newText)
          Activates the command input text field.
 void closeDialog(Gui dialog)
          Closes a dialog.
 boolean createKeyBinding(boolean perCharacter, CommandList commandList)
          Adds a key binding.
 CommandList getCommandList(java.lang.String args)
          Returns a command list.
 void openDialog(Gui dialog)
          Opens a dialog.
 void quitApplication()
          Terminates the application.
 boolean removeKeyBinding(boolean perCharacter)
          Removes a key binding.
 void toggleDialog(Gui dialog)
          Toggles a dialog.
 void updatePlayerName(java.lang.String playerName)
          Sets the current player name.
 

Method Detail

accountCreate

void accountCreate(@NotNull
                   java.lang.String login,
                   @NotNull
                   java.lang.String password)
Creates an account.

Parameters:
login - the account's name
password - the account's password

accountCreateCharacter

void accountCreateCharacter(@NotNull
                            java.lang.String login)
Creates a character. The password should be the last from accountLogin(java.lang.String, java.lang.String) or accountCreate(java.lang.String, java.lang.String).

Parameters:
login - the character's name

accountLink

void accountLink(int force,
                 @NotNull
                 java.lang.String login,
                 @NotNull
                 java.lang.String password)
Links a character to the current account.

Parameters:
force - 0 to allow failure, 1 to force in certain situations
login - the character's name
password - the character's password

accountLogin

void accountLogin(@NotNull
                  java.lang.String login,
                  @NotNull
                  java.lang.String password)
Login to an account.

Parameters:
login - login
password - password

accountPlayCharacter

void accountPlayCharacter(@NotNull
                          java.lang.String name)
Plays a character from the current account.

Parameters:
name - the character's name

activateCommandInput

void activateCommandInput(@NotNull
                          java.lang.String newText)
Activates the command input text field. If the skin defines more than one input field, the first matching one is selected.

If neither the main gui nor any visible dialog has an input text field, invisible GUIs are checked as well. If one is found, it is made visible.

Parameters:
newText - the new command text if non-null

closeDialog

void closeDialog(@NotNull
                 Gui dialog)
Closes a dialog. Does nothing if the dialog is not open.

Parameters:
dialog - the dialog to close

createKeyBinding

boolean createKeyBinding(boolean perCharacter,
                         @NotNull
                         CommandList commandList)
Adds a key binding.

Parameters:
perCharacter - whether a per-character key binding should be added
commandList - the command list to execute on key press
Returns:
whether the key bindings dialog should be opened

getCommandList

@NotNull
CommandList getCommandList(@NotNull
                                   java.lang.String args)
                           throws NoSuchCommandException
Returns a command list.

Parameters:
args - the command list arguments
Returns:
the command list
Throws:
NoSuchCommandException - if the command list does not exist

openDialog

void openDialog(@NotNull
                Gui dialog)
Opens a dialog. Does nothing if the dialog is open.

Parameters:
dialog - the dialog to open

quitApplication

void quitApplication()
Terminates the application.

removeKeyBinding

boolean removeKeyBinding(boolean perCharacter)
Removes a key binding.

Parameters:
perCharacter - whether a per-character key binding should be removed
Returns:
whether the key bindings dialog should be opened

toggleDialog

void toggleDialog(@NotNull
                  Gui dialog)
Toggles a dialog.

Parameters:
dialog - the dialog to toggle

updatePlayerName

void updatePlayerName(@NotNull
                      java.lang.String playerName)
Sets the current player name. Does nothing if not currently in the character name prompt.

Parameters:
playerName - the player name