API Docs for: 0.0.2
Show:

chess.view.command.Controller Class

Extends controller.Controller
Defined in: ../api/src/view/command/controller.js:1
Module: View

Controller for the command line view

Methods

addControllerEvents

()

Defined in ../api/src/view/command/controller.js:30

Add listeners to the controller

errorMessage

(
  • msg
)

Defined in ../api/src/view/command/controller.js:170

Fire a "sendErrorMessage" event. A chess.view.command.Panel view will listen to this event and display the error message on screen

Parameters:

execute

(
  • command
  • arg
)

Defined in ../api/src/view/command/controller.js:75

Execute a command

Parameters:

getCommandArguments

(
  • message
)
String private

Defined in ../api/src/view/command/controller.js:54

Extract command arguments from command message. The whole message would be returned when message is not a valid command.

Parameters:

Returns:

String:

Example:

var args = controller.getCommandArguments('move e4'); // will return "e4"

getValidCommand

(
  • command
)
String | Undefined private

Defined in ../api/src/view/command/controller.js:40

Return valid command name

Parameters:

Returns:

String | Undefined:

isChessMove

(
  • move
)
Boolean

Defined in ../api/src/view/command/controller.js:141

Using RegEx to validate a chess move.

Parameters:

Returns:

Boolean:

isValidGrade

(
  • arg
)
Boolean

Defined in ../api/src/view/command/controller.js:180

Returns true if passed argument is a valid move grade/short comment, i.e. !,?,!!,??,!? or ?!

Parameters:

Returns:

Boolean:

message

(
  • msg
)

Defined in ../api/src/view/command/controller.js:161

Fire a "sendMessage" event. Listening views may display this message on screen (example a chess.view.command.Panel view).

Parameters:

onInvalidMove

()

Defined in ../api/src/view/command/controller.js:134

Show invalid move message

receiveMove

(
  • controller
  • move
)
private

Defined in ../api/src/view/command/controller.js:150

Receive move from main controller and display move message on screen

Parameters:

recieveMoveUpdate

(
  • model
  • move
)

Defined in ../api/src/view/command/controller.js:190

Receive move update from main controller and fire a message event which will be displayed by a chess.view.command.Panel view

Parameters:

showHelp

()

Defined in ../api/src/view/command/controller.js:118

Show command line help screen