Module HOUND.Contact.Base
HOUND.Contact.Base Contact class.
containing related functions
Class HOUND.Contact.Base
Sector Mangment
HOUND.Contact.Base:getPrimarySector () | Get primaty sector for contact |
HOUND.Contact.Base:getSectors () | get sectors contact is threatening |
HOUND.Contact.Base:isInSector (sectorName) | check if threatens sector |
HOUND.Contact.Base:updateDefaultSector () | set correct sector 'default position' sector state |
HOUND.Contact.Base:updateSector (sectorName, inSector, threatsSector) | Update sector data |
HOUND.Contact.Base:addSector (sectorName) | add contact to names sector |
HOUND.Contact.Base:removeSector (sectorName) | remove contact from named sector |
HOUND.Contact.Base:isThreatsSector (sectorName) | check if contact in names sector |
Marker managment
HOUND.Contact.Base:removeMarkers () | Remove all contact's F10 map markers |
Class HOUND.Contact.Base
HOUND.Contact decleration
Contact class. containing related functions
- HOUND.Contact.Base:New (DcsObject, HoundCoalition)
-
create new HOUND.Contact instance
Parameters:
- DcsObject emitter DCS Unit
- HoundCoalition coalition Id of Hound Instace
Returns:
-
HOUND.Contact instance
- HOUND.Contact.Base:destroy ()
- Destructor function
- HOUND.Contact.Base:getDcsGroupName ()
-
Get Contact Group Name
Returns:
-
String
- HOUND.Contact.Base:getDcsName ()
-
Get the DCS unit name
Returns:
-
String
- HOUND.Contact.Base:getDcsObject ()
-
Get the underlying DCS Object
Returns:
-
DCS Unit or DCS staticObject
- HOUND.Contact.Base:getLastSeen ()
-
Get last seen in seconds
Returns:
-
number in seconds since contact was last seen
- HOUND.Contact.Base:getObject ()
-
get DCS Object instane assoiciated with contact
Returns:
-
DCS object (unit or group)
- HOUND.Contact.Base:hasPos ()
-
check if contact has estimated position
Returns:
-
Bool
True if contact has estimated position
- HOUND.Contact.Base:getMaxWeaponsRange ()
-
get max weapons range
Returns:
-
Number max weapon range of contact
- HOUND.Contact.Base:getRadarDetectionRange ()
-
get max detection range
Returns:
-
Number max detection range of contact
- HOUND.Contact.Base:getTypeAssigned ()
-
get type assinged string
Returns:
-
string
- HOUND.Contact.Base:getNatoDesignation ()
-
get NATO designation
Returns:
-
string
- HOUND.Contact.Base:isActive ()
-
Check if contact is Active
Returns:
-
Bool
True if seen in the last 15 seconds
- HOUND.Contact.Base:isRecent ()
-
check if contact is recent
Returns:
-
Bool
True if seen in the last 2 minutes
- HOUND.Contact.Base:isAccurate ()
-
check if contact position is accurate
Returns:
-
bool
- True target is pre briefed
- HOUND.Contact.Base:getPreBriefed ()
-
get preBriefed status
Returns:
-
bool
- True if target is prebriefed
- HOUND.Contact.Base:setPreBriefed (state)
-
set preBriefed status
Parameters:
- state
Returns:
-
bool
- True if target is prebriefed
- HOUND.Contact.Base:isTimedout ()
-
check if contact is timed out
Returns:
-
Bool
True if timed out
- HOUND.Contact.Base:getState ()
-
Get current state
Returns:
-
Contact state in HOUND.EVENTS
- HOUND.Contact.Base:queueEvent (eventId)
-
Queue new event
Parameters:
- eventId HOUND.EVENTS
- HOUND.Contact.Base:getEventQueue ()
-
get event queue
Returns:
-
table of event skeletons
Sector Mangment
- HOUND.Contact.Base:getPrimarySector ()
-
Get primaty sector for contact
Returns:
-
name of sector the position is in
- HOUND.Contact.Base:getSectors ()
-
get sectors contact is threatening
Returns:
-
list of sector names
- HOUND.Contact.Base:isInSector (sectorName)
-
check if threatens sector
Parameters:
- sectorName string
Returns:
-
Boot True if theat
- HOUND.Contact.Base:updateDefaultSector ()
- set correct sector 'default position' sector state
- HOUND.Contact.Base:updateSector (sectorName, inSector, threatsSector)
-
Update sector data
Parameters:
- HOUND.Contact.Base:addSector (sectorName)
-
add contact to names sector
Parameters:
- sectorName string name of sector
- HOUND.Contact.Base:removeSector (sectorName)
-
remove contact from named sector
Parameters:
- sectorName string name of sector
- HOUND.Contact.Base:isThreatsSector (sectorName)
-
check if contact in names sector
Parameters:
- sectorName string name of sector
Returns:
-
Bool
True if contact thretens sector