From BOARD18 Project WIKI
Jump to navigation Jump to search
This page has been updated to comply with Release 2.5.x of BOARD18. Go Back

The board18Map6.js file contains all the functions that respond to various onclick events on the game board in the Map page and on the main and tray menues. But events that cause a context menu to be displayed are handled by functions in the board18Map5.js file.

Function hideShow()

The hideShow function will use the BD18.gameBoard object methods to hide/show tiles and tokens on the map.

Function updateMenu(menuType)

The updateMenu function will update the menu move specific options.
The input menuType must be either 'active' or 'no'.
If the menuType is 'active' then the menu will contain as its first two options 'Accept Move' and 'Cancel Move'.
If the menuType is 'no' then the menu will contain as its first two options 'Undo Move' and 'Redo Move'.

Function makeTrayItems()

The makeTrayItems function will use the BD18.trays array to construct the items to be displayed in the tray menu.

Function registerTrayMenu()

The registerTrayMenu function creates the tray menu on the board18Map page. It uses the makeTrayItems function.

Function leftMenuEvent(key)

This function handles the selection of the leftMenu(Tray) and displays the proper BD18.tray.

Function tilePos(event)

This function calculates the board coordinates of a map tile given the raw coordinates of a mouse click event.

Function traySelect(event)

This function responds to onclick events in the trays canvas. It selects a item from those currently displayed and highlites the selected item.

Function hexSelect(event)

This function responds to left mousedown events in the map canvas. It checks various conditions and executes the appropriate function based on them. If it can find no relevant condition then it merely returns.

Function mapMouseEvent(event)

This function responds to mousedown events on the map canvas. It uses event.which to determine which mouse button was pressed. If the left or center button was pressed then it calls the hexSelect functon. Otherwise it assumes that the right button was pressed and calls the ContextMenu function.

Function ContextMenu(event)

This function uses makeMenuItems to create a ContextMenu. The menu will be positioned so as not to overlap the bounderies of the document. The displayed menu will not scroll.

Function doit(mm,e)

This function is called via onclick events coded into the main menu on the board18Map page. the passed parameter indicates the menue choice to be acted upon. mm is the onclick action to be taken.