Class MapContextMenu

The MapContextMenu is the main contextmenu shown to the user whenever it rightclicks on the map. It is the primary interaction method for the user. It allows to spawn units, create explosions and smoke, and edit CoalitionAreas.

Hierarchy

ContextMenu
- MapContextMenu

Constructors

constructor

new MapContextMenu(ID): MapContextMenu
Parameters
- ID: string
  
  the ID of the HTML element which will contain the context menu
Returns MapContextMenu
Overrides ContextMenu.constructor
- Defined in src/contextmenus/mapcontextmenu.ts:27

Properties

`Private` #aircraftSpawnMenu

#aircraftSpawnMenu: AircraftSpawnMenu

`Private` #coalitionArea

#coalitionArea: null | CoalitionArea = null

`Private` #coalitionSwitch

#coalitionSwitch: Switch

`Private` #container

#container: null | HTMLElement

`Private` #groundUnitSpawnMenu

#groundUnitSpawnMenu: GroundUnitSpawnMenu

`Private` #helicopterSpawnMenu

#helicopterSpawnMenu: HelicopterSpawnMenu

`Private` #latlng

#latlng: LatLng = ...

`Private` #navyUnitSpawnMenu

#navyUnitSpawnMenu: NavyUnitSpawnMenu

`Private` #visibleSubMenu

#visibleSubMenu: null | string = null

`Private` #x

#x: number = 0

`Private` #y

#y: number = 0

Methods

`Private` #hideSubMenus

#hideSubMenus(type): void
Hide all the submenus
Parameters
- type: string
  
  The type of the currenlt open submenu.
Returns void
- Defined in src/contextmenus/mapcontextmenu.ts:167

`Private` #onSwitchClick

#onSwitchClick(value): void
Callback called when the user left clicks on the coalition switch
Parameters
- value: boolean
  
  Switch position (false: "blue", true: "red")
Returns void
- Defined in src/contextmenus/mapcontextmenu.ts:196

`Private` #onSwitchRightClick

#onSwitchRightClick(): void
Callback called when the user rightclicks on the coalition switch. This will select the "neutral" coalition.

Returns void
- Defined in src/contextmenus/mapcontextmenu.ts:208

`Private` #showSubMenu

#showSubMenu(type): void
Shows the submenu depending on unit selection
Parameters
- type: string
  
  Submenu type, either "aircraft", "helicopter", "groundunit", "navyunit", "smoke", or "explosion"
Returns void
- Defined in src/contextmenus/mapcontextmenu.ts:129

clip

clip(): void
Clips the contextmenu, meaning it moves it on the screen to make sure it does not overflow the window.

Returns void
Inherited from ContextMenu.clip
- Defined in src/contextmenus/contextmenu.ts:76

getContainer

getContainer(): null | HTMLElement
Returns null | HTMLElement
The HTMLElement that contains the contextmenu
Inherited from ContextMenu.getContainer
- Defined in src/contextmenus/contextmenu.ts:45

getLatLng

getLatLng(): LatLng
Returns LatLng
The Leaflet latlng object associated to the click that caused the contextmenu to be shown
Inherited from ContextMenu.getLatLng
- Defined in src/contextmenus/contextmenu.ts:53

getVisibleSubMenu

getVisibleSubMenu(): null | string
Returns null | string
The name of the currently visible submenu
Inherited from ContextMenu.getVisibleSubMenu
- Defined in src/contextmenus/contextmenu.ts:102

getX

getX(): number
Returns number
The x coordinate of the top left corner of the menu
Inherited from ContextMenu.getX
- Defined in src/contextmenus/contextmenu.ts:61

getY

getY(): number
Returns number
The y coordinate of the top left corner of the menu
Inherited from ContextMenu.getY
- Defined in src/contextmenus/contextmenu.ts:69

hide

hide(): void
Hide the contextmenu

Returns void
Inherited from ContextMenu.hide
- Defined in src/contextmenus/contextmenu.ts:37

setCoalitionArea

setCoalitionArea(coalitionArea): void
If the user rightclicked on a CoalitionArea, it will be given the ability to edit it.
Parameters
- coalitionArea: CoalitionArea
  
  The CoalitionArea the user can edit
Returns void
- Defined in src/contextmenus/mapcontextmenu.ts:120

setVisibleSubMenu

setVisibleSubMenu(menu): void
Sets the currently visible submenu
Parameters
- menu: null | string
  
  The name of the currently visibile submenu, or null if no submenu is visible
Returns void
Inherited from ContextMenu.setVisibleSubMenu
- Defined in src/contextmenus/contextmenu.ts:94

show

show(x, y, latlng): void
Show the contextmenu on top of the map, usually at the location where the user has clicked on it.
Parameters
- x: number
  
  X screen coordinate of the top left corner of the context menu
- y: number
  
  Y screen coordinate of the top left corner of the context menu
- latlng: LatLng
  
  Leaflet latlng object of the mouse click
Returns void
Overrides ContextMenu.show
- Defined in src/contextmenus/mapcontextmenu.ts:87

Class MapContextMenu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ID: string

Returns MapContextMenu

Properties

Private #aircraftSpawnMenu

Private #coalitionArea

Private #coalitionSwitch

Private #container

Private #groundUnitSpawnMenu

Private #helicopterSpawnMenu

Private #latlng

Private #navyUnitSpawnMenu

Private #visibleSubMenu

Private #x

Private #y

Methods

Private #hideSubMenus

Parameters

type: string

Returns void

Private #onSwitchClick

Parameters

value: boolean

Returns void

Private #onSwitchRightClick

Returns void

Private #showSubMenu

Parameters

type: string

Returns void

clip

Returns void

getContainer

Returns null | HTMLElement

getLatLng

Returns LatLng

getVisibleSubMenu

Returns null | string

getX

Returns number

getY

Returns number

hide

Returns void

setCoalitionArea

Parameters

coalitionArea: CoalitionArea

Returns void

setVisibleSubMenu

Parameters

menu: null | string

Returns void

show

Parameters

x: number

y: number

latlng: LatLng

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` #aircraftSpawnMenu

`Private` #coalitionArea

`Private` #coalitionSwitch

`Private` #container

`Private` #groundUnitSpawnMenu

`Private` #helicopterSpawnMenu

`Private` #latlng

`Private` #navyUnitSpawnMenu

`Private` #visibleSubMenu

`Private` #x

`Private` #y

`Private` #hideSubMenus

`Private` #onSwitchClick

`Private` #onSwitchRightClick

`Private` #showSubMenu