Difference between revisions of "Board18Map6"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(added release note)
(complete rewrite)
Line 1: Line 1:
{{ReleaseNotice|1.0}}board18Map6.js contains all the functions that
{{ReleaseNoticeX|1.3|Design_Document_board18Map_Page}}  
The board18Map6.js file contains all the functions that
respond to various onclick events on the game board in the  
respond to various onclick events on the game board in the  
Map page and on the main and tray menus<br>But note that right click
Map page and on the main and tray menues.  But events
events that cause a context menu to be displayed are handled
that cause a context menu to be displayed are handled
by functions in the board18Map5.js file.
by functions in the board18Map5.js file.


==Function registerMainMenu()==
==Function hideShow()==
The registerMainMenu function creates the  
The hideShow function will use the  
main menu on the board18Map page. It uses
BD18.gameBoard object methods to hide/show tiles
the jquery context menu plugin.
and tokens on the map.


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


==Function registerTrayMenu()==
==Function registerTrayMenu() ==
The registerTrayMenu function creates the  
The registerTrayMenu function creates the  
tray menu on the board18Map page. It uses
tray menu on the board18Map page. It uses
Line 21: Line 22:
makeTrayItems function.
makeTrayItems function.


==Function tilePos(event)==
==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
This function calculates the board coordinates of a map
tile given the raw coordinates of a mouse click event.
tile given the raw coordinates of a mouse click event.


==Function traySelect(event)==
==Function traySelect(event) ==
This function responds to onclick events in the trays canvas.
This function responds to onclick events in the trays canvas.
It selects a item from those currently displayed and highlites
It selects a item from those currently displayed and highlites
the selected item.
the selected item.


==Function hexSelect(event)==
==Function hexSelect(event) ==
This function responds to left mousedown events in the   
This function responds to left mousedown events in the   
map canvas. It checks various conditions and executes  
map canvas. It checks various conditions and executes  
Line 36: Line 41:
no relevant condition then it merely returns.
no relevant condition then it merely returns.


==Function mapMouseEvent(event)==
==Function mapMouseEvent(event) ==
This function responds to mousedown events on the map canvas.
This function responds to all mousedown events on the map canvas.
It uses event.witch to determine which mouse button was pressed.
It uses event.witch to determine which mouse button was pressed.
If the left or center button was pressed then it calls the
If the left or center button was pressed then it calls the
hexSelect functon. Otherwise it assumes that the right button
hexSelect functon. Otherwise it assumes that the right button
was pressed and does nothing. Right mouse events are handled
was pressed and does nothing. Right mose events are handled
by the jquery.contextMenu library (see the makeMenus function in [[Board18Map5|board18Map5.js]]).
by the jquery.contextMenu library [see the makeMenus function].


==Function doit(mm)==
==Function doit(mm) ==
This function is called via onclick events coded into the
This function is called via onclick events coded into the
main menu on the board18Map page. the passed parameter  
main menu on the board18Map page. the passed parameter  
indicates the menu choice to be acted upon.
indicates the menue choice to be acted upon.

Revision as of 15:22, 4 December 2015

This page has been updated to comply with Release 1.3.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 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 jquery context menu plugin and 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 all mousedown events on the map canvas. It uses event.witch 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 does nothing. Right mose events are handled by the jquery.contextMenu library [see the makeMenus function].

Function doit(mm)

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.