Module HOUND.Contact.Site
HOUND.Contact.Site Site class containing related functions
See also:
Functions
Marker managment
| HOUND.Contact.Site:drawAreaMarker (numPoints) | Draw marker Polygon |
| HOUND.Contact.Site:updateMarker (MarkerType) | Update marker positions |
| HOUND.Contact.Site:updateMarkers (markerType, drawSite) | update position markers for site and radars |
Getters and Setters
Class HOUND.Contact.Site
| HOUND.Contact.Site:New (HoundContact, HoundCoalition[, SiteId]) | create new HOUND.Contact.Site instance |
| HOUND.Contact.Site:destroy () | Destructor function |
Emitter managment
Functions
- HOUND.Contact.Site:getTextData (utmZone, MGRSdigits)
-
return Information used in Text messages primary emitter
Parameters:
- utmZone (bool) True will add UTM zone to response
- MGRSdigits (Number) number of digits in the MGRS part of the response (eg. 2 = 12, 5=12345)
Returns:
-
GridPos (string) MGRS grid position (eg. "CY 564 123", "DN 2 4")
Return BE (string) Bullseye position string (eg. "035/15", "187/120")
- HOUND.Contact.Site:getTtsData (utmZone, MGRSdigits)
-
return Information used in TTS messages info will be that of primary emitter
Parameters:
- utmZone (bool) True will add UTM zone to response
- MGRSdigits (Number) number of digits in the MGRS part of the response (eg. 2 = 12, 5=12345)
Returns:
-
GridPos (string) MGRS grid position (eg. "Charlie Yankee one two Three four")
Return BE (string) Bullseye position string (eg. "Zero Three Five 15")
- HOUND.Contact.Site:getRadioItemText ()
-
generate Text for the Radio menu item
Returns:
-
string
- HOUND.Contact.Site:getRadioItemsText ()
-
Generate text items for entire site
Returns:
-
#table all radio items for site
- HOUND.Contact.Site:generatePopUpReport (isTTS, sectorName)
-
generate PopUp report
Parameters:
- isTTS Bool. If true message will be for TTS. False will make a text message
- sectorName string Name of primary sector if present function will only return sector data
Returns:
-
string. compiled message
- HOUND.Contact.Site:generateDeathReport (isTTS, sectorName)
-
generate Radar dead report
Parameters:
- isTTS Bool. If true message will be for TTS. False will make a text message
- sectorName string Name of primary sector if present function will only return sector data
Returns:
-
string. compiled message
- HOUND.Contact.Site:generateAsleepReport (isTTS, sectorName)
-
generate Radar dead report
Parameters:
- isTTS Bool. If true message will be for TTS. False will make a text message
- sectorName string Name of primary sector if present function will only return sector data
Returns:
-
string. compiled message
- HOUND.Contact.Site:generateLaunchAlert (isTTS, sectorName)
-
Generate a launch alert message.
Parameters:
- isTTS (bool) True if the message is for TTS, false for text message.
- sectorName string Name of the primary sector; if present, the message will include the sector name.
Returns:
-
string Compiled launch alert message.
- HOUND.Contact.Site:generateIdentReport (isTTS, sectorName)
-
generate Ident report
Parameters:
- isTTS Bool. If true message will be for TTS. False will make a text message
- sectorName string Name of primary sector if present function will only return sector data
Returns:
-
string. compiled message
- HOUND.Contact.Site:generateTtsBrief (NATO)
-
Generate TTS brief for the Site (for ATIS)
Parameters:
- NATO (bool) True will generate NATO Brevity brief
Returns:
-
string containing
- HOUND.Contact.Site:generateIntelBrief ()
-
Generate Intel brief Message (for export)
Returns:
-
string - compiled multi-line message for site
- HOUND.Contact.Site:export ()
-
Generate Site export object
Returns:
-
exported object
Marker managment
- HOUND.Contact.Site:drawAreaMarker (numPoints)
-
Draw marker Polygon
Parameters:
- numPoints integer number of points to draw (only 1,4,8 and 16 are valid)
- HOUND.Contact.Site:updateMarker (MarkerType)
-
Update marker positions
Parameters:
- MarkerType type of marker to use
- HOUND.Contact.Site:updateMarkers (markerType, drawSite)
-
update position markers for site and radars
Parameters:
- markerType requested HOUND.MARKER type
- drawSite optional boolean requested HOUND.MARKER for the site.
Getters and Setters
- HOUND.Contact.Site:getName ()
-
Get site name
Returns:
-
String
- HOUND.Contact.Site:setName (requestedName)
-
set Site Name
Parameters:
- requestedName requested name
- HOUND.Contact.Site:getType ()
-
Get site type name
Returns:
-
String
- HOUND.Contact.Site:getId ()
-
Get Site GID
Returns:
-
Number
- HOUND.Contact.Site:getDcsGroupName ()
-
Get Site Group Name
Returns:
-
String
- HOUND.Contact.Site:getDcsName ()
-
Get the DCS unit name
Returns:
-
String
- HOUND.Contact.Site:getDcsObject ()
-
Get the underlying DCS Object
Returns:
-
DCS Group or DCS staticObject
- HOUND.Contact.Site:getLastSeen ()
-
Get last seen in seconds
Returns:
-
number in seconds since contact was last seen
- HOUND.Contact.Site:getTypeAssigned ()
-
get type assinged string
Returns:
-
string
- HOUND.Contact.Site:isActive ()
-
Check if site is Active
Returns:
-
Bool
True if seen in the last 15 seconds
- HOUND.Contact.Site:isRecent ()
-
check if site is recent
Returns:
-
Bool
True if seen in the last 2 minutes
- HOUND.Contact.Site:isAccurate ()
-
check if site position is accurate
Returns:
-
bool
- True target is pre briefed
- HOUND.Contact.Site:isAlive ()
-
check if contact DCS Unit is still alive
Returns:
-
bool
True if object is considered Alive
- HOUND.Contact.Site:isTimedout ()
-
check if site is timed out
Returns:
-
Bool
True if timed out
- HOUND.Contact.Site:getState ()
-
Get current state
Returns:
-
site state in HOUND.EVENTS
- HOUND.Contact.Site:getPos ()
-
get current extimted position of primary
Returns:
-
DCS point - estimated position
- HOUND.Contact.Site:hasRadarUnits ()
-
Does site have any living radars still (for DBA)
Returns:
-
bool
true if any radars are alive in the group
Class HOUND.Contact.Site
HOUND.Contact.Site (Extends HOUND.Contact.Base)
Site class containing related functions
- HOUND.Contact.Site:New (HoundContact, HoundCoalition[, SiteId])
-
create new HOUND.Contact.Site instance
Parameters:
- HoundContact emitter HoundContact
- HoundCoalition coalition Id of Hound Instace
- SiteId specify uid for the Site. if not present Group ID will be used (optional)
Returns:
-
HOUND.Contact.Site instance
- HOUND.Contact.Site:destroy ()
- Destructor function
Emitter managment
- HOUND.Contact.Site:addEmitter (HoundEmitter)
-
Add emitter to site
Parameters:
- HoundEmitter HOUND.Contact.Emitter radar to add
Returns:
- HOUND.Contact.Site:removeEmitter (HoundEmitter)
-
Add emitter to site
Parameters:
- HoundEmitter HOUND.Contact.Emitter radar to remove
Returns:
- HOUND.Contact.Site:gcEmitters ()
- Prune Nil emitters
- HOUND.Contact.Site:updateGroupRadars ()
- update internal actual radars list
- HOUND.Contact.Site:getPrimary ()
-
Get site's primary emitter
Returns:
- HOUND.Contact.Site:getEmitters ()
-
get Dict with all emitters in site
Returns:
-
#table HOUND.Contact.Emitter
- HOUND.Contact.Site:countEmitters ()
-
get emitter count for site
Returns:
-
int
number of emitters currently in the site
- HOUND.Contact.Site:sortEmitters ()
- re-sort emitters
- HOUND.Contact.Site:selectPrimaryEmitter ()
-
select primaty emitter for site
Returns:
-
Bool
True if primary changed
- HOUND.Contact.Site:updateTypeAssigned ()
-
update site type
Returns:
-
Bool
True if site type changed
- HOUND.Contact.Site:updatePos ()
- update stored site pos
- HOUND.Contact.Site:ensurePrimaryHasPos (refPos)
-
Ensure primay emitter has position
Parameters:
- refPos DCS Point with adhock position if nothing else is available
- HOUND.Contact.Site:updateSector ()
- Update sector data
- HOUND.Contact.Site:LaunchDetected (cooldown)
-
trigger launch event
Parameters:
- cooldown interval between alerts. avoid spam
- HOUND.Contact.Site:processData ()
- Process site data (wrapper for consistency)
- HOUND.Contact.Site:update ()
- Update site data