Class UnitsManager

The UnitsManager handles the creation, update, and control of units. Data is strictly updated by the server ONLY. This means that any interaction from the user will always and only result in a command to the server, executed by means of a REST PUT request. Any subsequent change in data will be reflected only when the new data is sent back by the server. This strategy allows to avoid client/server and client/client inconsistencies.

Hierarchy

UnitsManager

Index

Constructors

constructor

new UnitsManager(): UnitsManager
Returns UnitsManager
- Defined in src/unit/unitsmanager.ts:28

Properties

`Private` #copiedUnits

#copiedUnits: UnitData[]

`Private` #hiddenTypes

#hiddenTypes: string[] = []

`Private` #requestDetectionUpdate

#requestDetectionUpdate: boolean = false

`Private` #selectionEventDisabled

#selectionEventDisabled: boolean = false

`Private` #units

#units: {
[ID: number]: Unit;
}

Type declaration

[ID: number]: Unit

Methods

`Private` #onKeyUp

#onKeyUp(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in src/unit/unitsmanager.ts:793

`Private` #onUnitDeselection

#onUnitDeselection(unit): void
Parameters
- unit: Unit
Returns void
- Defined in src/unit/unitsmanager.ts:820

`Private` #onUnitSelection

#onUnitSelection(unit): void
Parameters
- unit: Unit
Returns void
- Defined in src/unit/unitsmanager.ts:802

`Private` #showActionMessage

#showActionMessage(units, message): void
Parameters
- units: any[]
- message: string
Returns void
- Defined in src/unit/unitsmanager.ts:829

addUnit

addUnit(ID, category): void
Add a new unit to the manager
Parameters
- ID: number
  
  ID of the new unit
- category: string
  
  Either "Aircraft", "Helicopter", "GroundUnit", or "NavyUnit". Determines what class will be used to create the new unit accordingly.
Returns void
- Defined in src/unit/unitsmanager.ts:81

copyUnits

copyUnits(): void
Returns void
- Defined in src/unit/unitsmanager.ts:602

createIADS

createIADS(coalitionArea, types, eras, ranges, density, distribution): void
Parameters
- coalitionArea: CoalitionArea
- types: {
  [key: string]: boolean;
  }
  - [key: string]: boolean
- eras: {
  [key: string]: boolean;
  }
  - [key: string]: boolean
- ranges: {
  [key: string]: boolean;
  }
  - [key: string]: boolean
- density: number
- distribution: number
Returns void
- Defined in src/unit/unitsmanager.ts:673

deselectAllUnits

deselectAllUnits(): void
Returns void
- Defined in src/unit/unitsmanager.ts:227

deselectUnit

deselectUnit(ID): void
Parameters
- ID: number
Returns void
- Defined in src/unit/unitsmanager.ts:233

exportToFile

exportToFile(): void
Returns void
- Defined in src/unit/unitsmanager.ts:699

getByType

getByType(type): void
Parameters
- type: string
Returns void
- Defined in src/unit/unitsmanager.ts:275

getHiddenTypes

getHiddenTypes(): string[]
Returns string[]
- Defined in src/unit/unitsmanager.ts:183

getSelectedUnits

getSelectedUnits(options?): Unit[]
Parameters
- Optional options: {
  excludeHumans?: boolean;
  onlyOnePerGroup?: boolean;
  }
  - Optional excludeHumans?: boolean
  - Optional onlyOnePerGroup?: boolean
Returns Unit[]
- Defined in src/unit/unitsmanager.ts:205

getSelectedUnitsTypes

getSelectedUnitsTypes(): string[]
Returns string[]
- Defined in src/unit/unitsmanager.ts:267

getSelectedUnitsVariable

getSelectedUnitsVariable(variableGetter): any
Parameters
- variableGetter: CallableFunction
Returns any
- Defined in src/unit/unitsmanager.ts:271

getUnitByID

getUnitByID(ID): null | Unit
Get a specific unit by ID
Parameters
- ID: number
  
  ID of the unit. The ID shall be the same as the unit ID in DCS.
Returns null | Unit
Unit object, or null if no unit with said ID exists.
- Defined in src/unit/unitsmanager.ts:60

getUnitDetectedMethods

getUnitDetectedMethods(unit): number[]
Parameters
- unit: Unit
Returns number[]
- Defined in src/unit/unitsmanager.ts:281

getUnits

getUnits(): {
[ID: number]: Unit;
}
Returns {
[ID: number]: Unit;
}
All the existing units, both alive and dead
- [ID: number]: Unit
- Defined in src/unit/unitsmanager.ts:51

getUnitsByHotgroup

getUnitsByHotgroup(hotgroup): Unit[]
Returns all the units that belong to a hotgroup
Parameters
- hotgroup: number
  
  Hotgroup number
Returns Unit[]
Array of units that belong to hotgroup
- Defined in src/unit/unitsmanager.ts:72

getUnitsTypes

getUnitsTypes(units): string[]
Parameters
- units: Unit[]
Returns string[]
- Defined in src/unit/unitsmanager.ts:246

getUnitsVariable

getUnitsVariable(variableGetter, units): any
Parameters
- variableGetter: CallableFunction
- units: Unit[]
Returns any
- Defined in src/unit/unitsmanager.ts:257

importFromFile

importFromFile(): void
Returns void
- Defined in src/unit/unitsmanager.ts:718

pasteUnits

pasteUnits(): undefined | false
Returns undefined | false
- Defined in src/unit/unitsmanager.ts:607

selectFromBounds

selectFromBounds(bounds): void
Parameters
- bounds: LatLngBounds
Returns void
- Defined in src/unit/unitsmanager.ts:193

selectUnit

selectUnit(ID, deselectAllUnits?): void
Parameters
- ID: number
- deselectAllUnits: boolean = true
Returns void
- Defined in src/unit/unitsmanager.ts:187

selectUnitsByHotgroup

selectUnitsByHotgroup(hotgroup): void
Parameters
- hotgroup: number
Returns void
- Defined in src/unit/unitsmanager.ts:241

selectedUnitsAddDestination

selectedUnitsAddDestination(latlng, mantainRelativePosition, rotation): void
********************* Actions on selected units ***********************
Parameters
- latlng: LatLng
- mantainRelativePosition: boolean
- rotation: number
Returns void
- Defined in src/unit/unitsmanager.ts:295

selectedUnitsAddToHotgroup

selectedUnitsAddToHotgroup(hotgroup): void
Parameters
- hotgroup: number
Returns void
- Defined in src/unit/unitsmanager.ts:519

selectedUnitsAttackUnit

selectedUnitsAttackUnit(ID): void
Parameters
- ID: number
Returns void
- Defined in src/unit/unitsmanager.ts:435

selectedUnitsBombBuilding

selectedUnitsBombBuilding(mouseCoordinates): void
Parameters
- mouseCoordinates: LatLng
Returns void
- Defined in src/unit/unitsmanager.ts:575

selectedUnitsBombPoint

selectedUnitsBombPoint(mouseCoordinates): void
Parameters
- mouseCoordinates: LatLng
Returns void
- Defined in src/unit/unitsmanager.ts:559

selectedUnitsCarpetBomb

selectedUnitsCarpetBomb(mouseCoordinates): void
Parameters
- mouseCoordinates: LatLng
Returns void
- Defined in src/unit/unitsmanager.ts:567

selectedUnitsChangeAltitude

selectedUnitsChangeAltitude(altitudeChange): void
Parameters
- altitudeChange: string
Returns void
- Defined in src/unit/unitsmanager.ts:355

selectedUnitsChangeSpeed

selectedUnitsChangeSpeed(speedChange): void
Parameters
- speedChange: string
Returns void
- Defined in src/unit/unitsmanager.ts:348

selectedUnitsClearDestinations

selectedUnitsClearDestinations(): void
Returns void
- Defined in src/unit/unitsmanager.ts:324

selectedUnitsComputeGroupDestination

selectedUnitsComputeGroupDestination(latlng, rotation): {
[key: number]: LatLng;
}
Parameters
- latlng: LatLng
- rotation: number
Returns {
[key: number]: LatLng;
}
- [key: number]: LatLng
- Defined in src/unit/unitsmanager.ts:528

selectedUnitsCreateGroup

selectedUnitsCreateGroup(): void
Returns void
- Defined in src/unit/unitsmanager.ts:591

selectedUnitsDelete

selectedUnitsDelete(explosion?): void
Parameters
- explosion: boolean = false
Returns void
- Defined in src/unit/unitsmanager.ts:443

selectedUnitsFireAtArea

selectedUnitsFireAtArea(mouseCoordinates): void
Parameters
- mouseCoordinates: LatLng
Returns void
- Defined in src/unit/unitsmanager.ts:583

selectedUnitsFollowUnit

selectedUnitsFollowUnit(ID, offset?, formation?): void
Parameters
- ID: number
- Optional offset: {
      x: number;
      y: number;
      z: number;
  }
  - x: number
  - y: number
  - z: number
- Optional formation: string
Returns void
- Defined in src/unit/unitsmanager.ts:471

selectedUnitsLandAt

selectedUnitsLandAt(latlng): void
Parameters
- latlng: LatLng
Returns void
- Defined in src/unit/unitsmanager.ts:340

selectedUnitsRefuel

selectedUnitsRefuel(): void
Returns void
- Defined in src/unit/unitsmanager.ts:463

selectedUnitsSetAltitude

selectedUnitsSetAltitude(altitude): void
Parameters
- altitude: number
Returns void
- Defined in src/unit/unitsmanager.ts:378

selectedUnitsSetAltitudeType

selectedUnitsSetAltitudeType(altitudeType): void
Parameters
- altitudeType: string
Returns void
- Defined in src/unit/unitsmanager.ts:386

selectedUnitsSetEmissionsCountermeasures

selectedUnitsSetEmissionsCountermeasures(emissionCountermeasure): void
Parameters
- emissionCountermeasure: string
Returns void
- Defined in src/unit/unitsmanager.ts:410

selectedUnitsSetFollowRoads

selectedUnitsSetFollowRoads(followRoads): void
Parameters
- followRoads: boolean
Returns void
- Defined in src/unit/unitsmanager.ts:426

selectedUnitsSetHotgroup

selectedUnitsSetHotgroup(hotgroup): void
Parameters
- hotgroup: number
Returns void
- Defined in src/unit/unitsmanager.ts:514

selectedUnitsSetOnOff

selectedUnitsSetOnOff(onOff): void
Parameters
- onOff: boolean
Returns void
- Defined in src/unit/unitsmanager.ts:418

selectedUnitsSetROE

selectedUnitsSetROE(ROE): void
Parameters
- ROE: string
Returns void
- Defined in src/unit/unitsmanager.ts:394

selectedUnitsSetReactionToThreat

selectedUnitsSetReactionToThreat(reactionToThreat): void
Parameters
- reactionToThreat: string
Returns void
- Defined in src/unit/unitsmanager.ts:402

selectedUnitsSetSpeed

selectedUnitsSetSpeed(speed): void
Parameters
- speed: number
Returns void
- Defined in src/unit/unitsmanager.ts:362

selectedUnitsSetSpeedType

selectedUnitsSetSpeedType(speedType): void
Parameters
- speedType: string
Returns void
- Defined in src/unit/unitsmanager.ts:370

setHiddenType

setHiddenType(key, value): void
Parameters
- key: string
- value: boolean
Returns void
- Defined in src/unit/unitsmanager.ts:173

spawnUnits

spawnUnits(category, units, coalition?, immediate?, airbase?, country?, callback?): boolean
Parameters
- category: string
- units: any
- coalition: string = "blue"
- immediate: boolean = true
- airbase: string = ""
- country: string = ""
- callback: CallableFunction = ...
Returns boolean
- Defined in src/unit/unitsmanager.ts:745

update

update(buffer): number
Update the data of all the units. The data is directly decoded from the binary buffer received from the REST Server. This is necessary for performance and bandwidth reasons.
Parameters
- buffer: ArrayBuffer
  
  The arraybuffer, encoded according to the ICD defined in: TODO Add reference to ICD
Returns number
The decoded updateTime of the data update.
- Defined in src/unit/unitsmanager.ts:96

Class UnitsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns UnitsManager

Properties

Private #copiedUnits

Private #hiddenTypes

Private #requestDetectionUpdate

Private #selectionEventDisabled

Private #units

Type declaration

[ID: number]: Unit

Methods

Private #onKeyUp

Parameters

event: KeyboardEvent

Returns void

Private #onUnitDeselection

Parameters

unit: Unit

Returns void

Private #onUnitSelection

Parameters

unit: Unit

Returns void

Private #showActionMessage

Parameters

units: any[]

message: string

Returns void

addUnit

Parameters

ID: number

category: string

Returns void

copyUnits

Returns void

createIADS

Parameters

coalitionArea: CoalitionArea

types: { [key: string]: boolean; }

[key: string]: boolean

eras: { [key: string]: boolean; }

[key: string]: boolean

ranges: { [key: string]: boolean; }

[key: string]: boolean

density: number

distribution: number

Returns void

deselectAllUnits

Returns void

deselectUnit

Parameters

ID: number

Returns void

exportToFile

Returns void

getByType

Parameters

type: string

Returns void

getHiddenTypes

Returns string[]

getSelectedUnits

Parameters

Optional options: { excludeHumans?: boolean; onlyOnePerGroup?: boolean; }

Optional excludeHumans?: boolean

Optional onlyOnePerGroup?: boolean

Returns Unit[]

getSelectedUnitsTypes

Returns string[]

getSelectedUnitsVariable

Parameters

variableGetter: CallableFunction

Returns any

`Private` #copiedUnits

`Private` #hiddenTypes

`Private` #requestDetectionUpdate

`Private` #selectionEventDisabled

`Private` #units

`Private` #onKeyUp

`Private` #onUnitDeselection

`Private` #onUnitSelection

`Private` #showActionMessage

types: {
[key: string]: boolean;
}

eras: {
[key: string]: boolean;
}

ranges: {
[key: string]: boolean;
}

`Optional` options: {
excludeHumans?: boolean;
onlyOnePerGroup?: boolean;
}

`Optional` excludeHumans?: boolean

`Optional` onlyOnePerGroup?: boolean

Returns {
[ID: number]: Unit;
}