Class AirbaseContextMenu

This context menu is shown to the user when the airbase marker is right clicked on the map. It allows the user to inspect information about the airbase, as well as allowing to spawn units from the airbase itself and land units on it.

Hierarchy

ContextMenu
- AirbaseContextMenu

Index

Constructors

constructor

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

Properties

`Private` #airbase

#airbase: null | Airbase = null

`Private` #container

#container: null | HTMLElement

`Private` #latlng

#latlng: LatLng = ...

`Private` #visibleSubMenu

#visibleSubMenu: null | string = null

`Private` #x

#x: number = 0

`Private` #y

#y: number = 0

Methods

`Private` #setAirbaseData

#setAirbaseData(): void
Returns void

Todo
needs commenting
- Defined in src/contextmenus/airbasecontextmenu.ts:120

`Private` #setCoalition

#setCoalition(coalition): void
Parameters
- coalition: string
  
  Coalition to which the airbase belongs
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:87

`Private` #setName

#setName(airbaseName): void
Parameters
- airbaseName: string
  
  The name of the airbase
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:53

`Private` #setParkings

#setParkings(airbaseParkings): void
Parameters
- airbaseParkings: string[]
  
  List of available parkings at the airbase
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:75

`Private` #setProperties

#setProperties(airbaseProperties): void
Parameters
- airbaseProperties: string[]
  
  The properties of the airbase
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:63

`Private` #showLandButton

#showLandButton(showLandButton): void
Parameters
- showLandButton: boolean
  
  If true, the land button will be visible
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:103

`Private` #showSpawnButton

#showSpawnButton(showSpawnButton): void
Parameters
- showSpawnButton: boolean
  
  If true, the spawn button will be visibile
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:95

`Private` #showSpawnMenu

#showSpawnMenu(): void
Shows the spawn context menu which allows the user to select a unit to ground spawn at the airbase

Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:110

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

setAirbase

setAirbase(airbase): void
Sets the airbase for which data will be shown in the context menu
Parameters
- airbase: Airbase
  
  The airbase for which data will be shown in the context menu. Note: the airbase must be present in the public/databases/airbases/.json database.
Returns void
- Defined in src/contextmenus/airbasecontextmenu.ts:35

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
Inherited from ContextMenu.show
- Defined in src/contextmenus/contextmenu.ts:26

Class AirbaseContextMenu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ID: string

Returns AirbaseContextMenu

Properties

Private #airbase

Private #container

Private #latlng

Private #visibleSubMenu

Private #x

Private #y

Methods

Private #setAirbaseData

Returns void

Todo

Private #setCoalition

Parameters

coalition: string

Returns void

Private #setName

Parameters

airbaseName: string

Returns void

Private #setParkings

Parameters

airbaseParkings: string[]

Returns void

Private #setProperties

Parameters

airbaseProperties: string[]

Returns void

Private #showLandButton

Parameters

showLandButton: boolean

Returns void

Private #showSpawnButton

Parameters

showSpawnButton: boolean

Returns void

Private #showSpawnMenu

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

setAirbase

Parameters

airbase: Airbase

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` #airbase

`Private` #container

`Private` #latlng

`Private` #visibleSubMenu

`Private` #x

`Private` #y

`Private` #setAirbaseData

`Private` #setCoalition

`Private` #setName

`Private` #setParkings

`Private` #setProperties

`Private` #showLandButton

`Private` #showSpawnButton

`Private` #showSpawnMenu