Difference between revisions of "Board18SnapMap"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(→‎Function makeTrayItems(): add Function hideShow())
(complete rewrite)
Line 1: Line 1:
{{ReleaseNoticeX|1.3|Design_Document_board18SnapMap_Page}}
{{ReleaseNoticeX|1.3|Design_Document_board18SnapMap_Page}}
The board18SnapMap.js file contains all the functions that
The board18SnapMap.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  
SnapMap page and on the main and tray menues.  But note that  
and on the main and tray menues in the
right click events are not used on snapshot displays.
board18SnapMap page.  But note that  
right click events are not used on the board18SnapMap page.


==Function hideShow()==
== Function hideShow()==
The hideShow function will hide or show tiles on the map
The hideShow function will hide or show tiles on the map
of the game board page.
of the board18SnapMap page.


==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 board18SnapMap page. It uses
tray menu on the board18SnapMap page. It uses
Line 20: Line 21:
makeTrayItems function.
makeTrayItems function.


==Function makeMenus()==
== Function leftMenuEvent(key) ==
This function handles the selection of the leftMenu(Tray)
and displays the proper BD18.tray.
 
== Function makeMenus() ==
 
This makeMenus function is a stub to make board18SnapMap
This makeMenus function is a stub to make board18SnapMap
compatable with board18Map2.js
compatable with board18Map2.php
 
== Function delayCheckForUpdate()  ==


==Function delayCheckForUpdate()==
This delayCheckForUpdate function is a stub to make  
This delayCheckForUpdate function is a stub to make board18SnapMap
board18SnapMap compatable with board18Map2.php
compatable with board18Map2.js

Revision as of 10:53, 11 December 2015

This page has been updated to comply with Release 1.3.x of BOARD18. Go Back

The board18SnapMap.js file contains all the functions that respond to various onclick events on the game board and on the main and tray menues in the board18SnapMap page. But note that right click events are not used on the board18SnapMap page.

Function hideShow()

The hideShow function will hide or show tiles on the map of the board18SnapMap page.

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 board18SnapMap 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 makeMenus()

This makeMenus function is a stub to make board18SnapMap compatable with board18Map2.php

Function delayCheckForUpdate()

This delayCheckForUpdate function is a stub to make board18SnapMap compatable with board18Map2.php