Module HOUND.Sector

HOUND.Sector

Functions

HOUND.Sector:populateRadioMenu () Populate sector radio menu
HOUND.Sector:removeMenuItems (menu, grpId) recursivly clean out a menu

Local Functions

HOUND.Sector:getRadioItemsText () generate menu cache
HOUND.Sector:createCheckIn () create check menu items for players
HOUND.Sector:getMenuPage (menu, grpId, parent) Handle menu pagination
HOUND.Sector:getMenuObj () get new menu object
HOUND.Sector:addSiteRadioItems (typeMenu, requester, siteData) create site menu item
HOUND.Sector:removeSiteRadioItems (typeMenu, requester, siteData) remove radar menu items

Class HOUND.Sector

HOUND.Sector.create (HoundId, name[, settings[, priority]]) Create sectors
HOUND.Sector:updateSettings (settings) Update sectore settings
HOUND.Sector:destroy () Sector "Destructor" cleans up everyting needed for sector to safly be removed
HOUND.Sector:updateServices () Update internal services with settings stored in the sector.

getters and setters

HOUND.Sector:getName () get name
HOUND.Sector:getPriority () get priority
HOUND.Sector:setCallsign (callsign[, NATO]) set callsign for sector
HOUND.Sector:getCallsign () get callsign for sector
HOUND.Sector:getZone () get zone polygon
HOUND.Sector:hasZone () has zone
HOUND.Sector:setZone (zonecandidate) Set zone in sector
HOUND.Sector:removeZone () Remove Zone settings from sector
HOUND.Sector:setTransmitter (userTransmitter) sets transmitter to sector
HOUND.Sector:updateTransmitter () updates all available comms with transmitter on file
HOUND.Sector:removeTransmitter () removes transmitter from sector

Controller Functions

HOUND.Sector:enableController ([userSettings]) enable controller
HOUND.Sector:disableController () disable controller
HOUND.Sector:removeController () remove controller completly from sector
HOUND.Sector:getControllerFreq () get controller frequencies
HOUND.Sector:hasController () checks for controller in sector
HOUND.Sector:isControllerEnabled () checks if controller is enabled for the sector
HOUND.Sector:getController () If Controller exists on sector, return controller object
HOUND.Sector:transmitOnController (msg, priority) Transmit custom TTS message on controller
HOUND.Sector:enableText () enable controller text for sector
HOUND.Sector:disableText () disable controller text for sector
HOUND.Sector:enableAlerts () enable controller Alerts for sector
HOUND.Sector:disableAlerts () disable controller for sector
HOUND.Sector:enableTTS () enable Controller tts for sector
HOUND.Sector:disableTTS () disable Controller tts for sector

ATIS Functions

HOUND.Sector:enableAtis (userSettings) enable ATIS in sector
HOUND.Sector:disableAtis () disable ATIS in sector
HOUND.Sector:removeAtis () remove ATIS from sector
HOUND.Sector:getAtisFreq () get ATIS frequencies
HOUND.Sector:reportEWR (state) Set ATIS EWR report state
HOUND.Sector:hasAtis () checks for atis in sector
HOUND.Sector:isAtisEnabled () checks if ats is enabled for the sector

Notifier Functions

HOUND.Sector:enableNotifier ([userSettings]) enable Notifier in sector
HOUND.Sector:disableNotifier () disable notifier in sector
HOUND.Sector:removeNotifier () remove notifier in sector
HOUND.Sector:getNotifierFreq () get Notifier frequencies
HOUND.Sector:hasNotifier () checks sector for notifier
HOUND.Sector:isNotifierEnabled () checks if ats is enabled for the sector
HOUND.Sector:getNotifier () If notifier exists on sector, return notifier opject
HOUND.Sector:transmitOnNotifier (msg, priority) Transmit custom TTS message on Notifier

Contact Functions

HOUND.Sector:getContacts () return a sorted list of all contacts for the sector
HOUND.Sector:countContacts () count the number of contacts for the sector
HOUND.Sector:updateSectorMembership (contact) update contact for zone memberships
HOUND.Sector:getSites () return a sorted list of all contacts for the sector
HOUND.Sector:countSites () count the number of contacts for the sector

Radio Menu

HOUND.Sector.removeRadioMenu (self) remove all radio menus for
HOUND.Sector:findGrpInPlayerList (grpId[, playersList]) find group in enrolled
HOUND.Sector:getSubscribedGroups () get subscribed groups
HOUND.Sector:validateEnrolled () clean non existing users from subscribers
HOUND.Sector.checkIn (args[, skipAck]) check in player to controller
HOUND.Sector.checkOut (args[, skipAck[, onlyPlayer]]) check out player's group from controller
HOUND.Sector:isNotifiying () Check if sector can notify
HOUND.Sector:getTransmissionAnnounce ([index]) create randome annouce
HOUND.Sector:notifyEmitterDead (contact) Send dead emitter notification
HOUND.Sector:notifyEmitterNew (contact) Send new emitter notification
HOUND.Sector:notifySiteIdentified (site) Notify a site was reclassified
HOUND.Sector:notifySiteNew (site) Notify a site was created
HOUND.Sector:notifySiteDead (site, isDead) Notify a site was destroyed
HOUND.Sector:notifySiteLaunching (site) Notify that a site is launching.
HOUND.Sector:generateAtis (loopData, AtisPreferences) Generate Atis message for sector
HOUND.Sector.TransmitSamReport (args) transmit SAM report
HOUND.Sector:TransmitCheckInAck (player) transmit checkin message
HOUND.Sector:TransmitCheckOutAck (player) transmit checkout message


Functions

HOUND.Sector:populateRadioMenu ()
Populate sector radio menu
HOUND.Sector:removeMenuItems (menu, grpId)
recursivly clean out a menu

Parameters:

  • menu
  • grpId GroupId to remove from

Local Functions

HOUND.Sector:getRadioItemsText ()
generate menu cache

Returns:

    #table radio items text
HOUND.Sector:createCheckIn ()
create check menu items for players
HOUND.Sector:getMenuPage (menu, grpId, parent)
Handle menu pagination

Parameters:

  • menu to paginate
  • grpId group Id for menus
  • parent root menu if required

Returns:

    reference to the current page to use
HOUND.Sector:getMenuObj ()
get new menu object

Returns:

    table
HOUND.Sector:addSiteRadioItems (typeMenu, requester, siteData)
create site menu item

Parameters:

  • typeMenu table containg the assigned type menu
  • requester MIST player object
  • siteData #table of site from menu cache
HOUND.Sector:removeSiteRadioItems (typeMenu, requester, siteData)
remove radar menu items

Parameters:

  • typeMenu table contaning a menu structure for the group
  • requester mist human player object
  • siteData #table of site from menu cache

Class HOUND.Sector

HOUND.Sector
HOUND.Sector.create (HoundId, name[, settings[, priority]])
Create sectors

Parameters:

  • HoundId Hound Instance ID
  • name Sector name
  • settings Sector settings table (optional)
  • priority Priority for the sector (optional)
HOUND.Sector:updateSettings (settings)
Update sectore settings

Parameters:

  • settings table of settings for internal services

Usage:

    local sectorSettings = {
     atis = {
         freq = 123.45
     },
     controller = {
         freq = 234.56
     },
     notifier = {
         freq = 243.00
     }
 }
 sector:updateSettings(sectorSettings)
HOUND.Sector:destroy ()
Sector "Destructor" cleans up everyting needed for sector to safly be removed

Returns:

    nil is returned
HOUND.Sector:updateServices ()
Update internal services with settings stored in the sector.

getters and setters

HOUND.Sector:getName ()
get name

Returns:

    string name of sector
HOUND.Sector:getPriority ()
get priority

Returns:

    int priority of sector
HOUND.Sector:setCallsign (callsign[, NATO])
set callsign for sector

Parameters:

  • callsign string Requested Callsign
  • NATO boolean Use NATO pool for callsignes (optional)
HOUND.Sector:getCallsign ()
get callsign for sector

Returns:

    string Callsign for current sector
HOUND.Sector:getZone ()
get zone polygon

Returns:

    table of points or nil
HOUND.Sector:hasZone ()
has zone

Returns:

    bool True if sector has zone
HOUND.Sector:setZone (zonecandidate)
Set zone in sector

Parameters:

  • zonecandidate (String) DCS group name, or a drawn map freeform Polygon. sector borders will be group waypoints or polygon points
HOUND.Sector:removeZone ()
Remove Zone settings from sector
HOUND.Sector:setTransmitter (userTransmitter)
sets transmitter to sector

Parameters:

  • userTransmitter (String) Name of the Unit that would be transmitting
HOUND.Sector:updateTransmitter ()
updates all available comms with transmitter on file
HOUND.Sector:removeTransmitter ()
removes transmitter from sector

Controller Functions

HOUND.Sector:enableController ([userSettings])
enable controller

Parameters:

  • userSettings contoller settings (optional)
HOUND.Sector:disableController ()
disable controller
HOUND.Sector:removeController ()
remove controller completly from sector
HOUND.Sector:getControllerFreq ()
get controller frequencies
HOUND.Sector:hasController ()
checks for controller in sector

Returns:

    true if Sector has controller
HOUND.Sector:isControllerEnabled ()
checks if controller is enabled for the sector

Returns:

    true if Sector controller is enabled
HOUND.Sector:getController ()
If Controller exists on sector, return controller object

Returns:

    HOUND.COMMS.Controller
HOUND.Sector:transmitOnController (msg, priority)
Transmit custom TTS message on controller

Parameters:

  • msg string string to broadcast
  • priority optional number message priority, default is 1 (high priority)
HOUND.Sector:enableText ()
enable controller text for sector
HOUND.Sector:disableText ()
disable controller text for sector
HOUND.Sector:enableAlerts ()
enable controller Alerts for sector
HOUND.Sector:disableAlerts ()
disable controller for sector
HOUND.Sector:enableTTS ()
enable Controller tts for sector
HOUND.Sector:disableTTS ()
disable Controller tts for sector

ATIS Functions

HOUND.Sector:enableAtis (userSettings)
enable ATIS in sector

Parameters:

  • userSettings ATIS settings array
HOUND.Sector:disableAtis ()
disable ATIS in sector
HOUND.Sector:removeAtis ()
remove ATIS from sector
HOUND.Sector:getAtisFreq ()
get ATIS frequencies
HOUND.Sector:reportEWR (state)
Set ATIS EWR report state

Parameters:

  • state boolean True will report EWR
HOUND.Sector:hasAtis ()
checks for atis in sector

Returns:

    true if Sector has atis
HOUND.Sector:isAtisEnabled ()
checks if ats is enabled for the sector

Returns:

    true if Sector ats is enabled

Notifier Functions

HOUND.Sector:enableNotifier ([userSettings])
enable Notifier in sector

Parameters:

  • userSettings table of settings for Notifier (optional)
HOUND.Sector:disableNotifier ()
disable notifier in sector
HOUND.Sector:removeNotifier ()
remove notifier in sector

Returns:

    true if Sector has notifier
HOUND.Sector:getNotifierFreq ()
get Notifier frequencies
HOUND.Sector:hasNotifier ()
checks sector for notifier
HOUND.Sector:isNotifierEnabled ()
checks if ats is enabled for the sector

Returns:

    true if Sector ats is enabled
HOUND.Sector:getNotifier ()
If notifier exists on sector, return notifier opject

Returns:

    HOUND.COMMS.Notifier
HOUND.Sector:transmitOnNotifier (msg, priority)
Transmit custom TTS message on Notifier

Parameters:

  • msg string string to broadcast
  • priority number message priority, default is 1 (high priority)

Contact Functions

HOUND.Sector:getContacts ()
return a sorted list of all contacts for the sector
HOUND.Sector:countContacts ()
count the number of contacts for the sector
HOUND.Sector:updateSectorMembership (contact)
update contact for zone memberships

Parameters:

  • contact HOUND.Contact instance
HOUND.Sector:getSites ()
return a sorted list of all contacts for the sector
HOUND.Sector:countSites ()
count the number of contacts for the sector

Returns:

    int Number of contacts

Radio Menu

HOUND.Sector.removeRadioMenu (self)
remove all radio menus for

Parameters:

  • self HOUND.Sector
HOUND.Sector:findGrpInPlayerList (grpId[, playersList])
find group in enrolled

Parameters:

  • grpId GroupId (int)
  • playersList list of mist.DB units to find all the group members in (optional)

Returns:

    list of enrolled players in grp
HOUND.Sector:getSubscribedGroups ()
get subscribed groups

Returns:

    list of groupsId
HOUND.Sector:validateEnrolled ()
clean non existing users from subscribers
HOUND.Sector.checkIn (args[, skipAck])
check in player to controller

Parameters:

  • args table {self=<HOUND.Sector>,player=<player>}
  • skipAck Bool if true do not reply with ack to player (optional)
HOUND.Sector.checkOut (args[, skipAck[, onlyPlayer]])
check out player's group from controller

Parameters:

  • args table {self=<HOUND.Sector>,player=<player>}
  • skipAck Bool if true do not reply with ack to player (optional)
  • onlyPlayer Bool. if true, only the player and not his flight (eg. slot change for player) (optional)
HOUND.Sector:isNotifiying ()
Check if sector can notify
HOUND.Sector:getTransmissionAnnounce ([index])
create randome annouce

Parameters:

  • index of requested announce (optional)

Returns:

    string Announcement
HOUND.Sector:notifyEmitterDead (contact)
Send dead emitter notification

Parameters:

  • contact HounContact instace
HOUND.Sector:notifyEmitterNew (contact)
Send new emitter notification

Parameters:

  • contact HounContact instace
HOUND.Sector:notifySiteIdentified (site)
Notify a site was reclassified

Parameters:

HOUND.Sector:notifySiteNew (site)
Notify a site was created

Parameters:

HOUND.Sector:notifySiteDead (site, isDead)
Notify a site was destroyed

Parameters:

HOUND.Sector:notifySiteLaunching (site)
Notify that a site is launching. This function sends a notification when a site is launching if alerts are enabled. It checks if the sector is set to notify and if the site belongs to the primary sector. The notification is sent to both the controller and notifier if they are enabled.

Parameters:

HOUND.Sector:generateAtis (loopData, AtisPreferences)
Generate Atis message for sector

Parameters:

  • loopData HoundInfomationSystem loop table
  • AtisPreferences HoundInfomationSystem settings table
HOUND.Sector.TransmitSamReport (args)
transmit SAM report

Parameters:

  • args table {self=<HOUND.Sector>,contact=<HOUND.Contact>,requester=<player>}
HOUND.Sector:TransmitCheckInAck (player)
transmit checkin message

Parameters:

  • player Player entity
HOUND.Sector:TransmitCheckOutAck (player)
transmit checkout message

Parameters:

  • player Player entity
generated by LDoc 1.5.0 Last updated 2025-07-24 22:32:18