Built In Functions

From EuroScopeWiki

Revision as of 17:15, 11 May 2014; view current revision
←Older revision | Newer revision→
Jump to: navigation, search
Previous: Command Line Reference Actual: Built In Functions Next: Tower View

Available Functions

Functions are quite similar to aliases. There are some kind of string patterns that will be replaced by the system. The real difference is that in one hand their names are fixed coming from the code not from a file, on the other hand the result depends on the current session rather than a fixed value. A function may stand on its own or may have parameters. Parameters can come from anywhere even it can be a result of another function or can be am alias parameter. Functions are evaluated in the command line and in the ATIS message lines. And since version 2.8h the letter-by-letter voice ATIS elements also use them. Aliases are not forgotten but as they are extracted by typing in the command line the functions in them will be evaluated there as well.

  • $aircraft
    The callsign of the selected aircraft.
  • $alt
    The temporary, the sector entry/exit or the final altitude (if none of the preciouses are specified) of the selected aircraft.
  • $altim(station)
    The altitude pressure value from the METAR of the station. For availability see $metar
  • $arr
    The destination airport of the selected aircraft.
  • $arrrwy [(airport ICAO code)]
    A comma separated list of the runways set as active for arrivals. If no parameter is defined then the assigned arrival RWY of the ASEL aircraft.
  • $asquawk
    The assigned SQUAWK code.
  • $atccallsign [(handoffid)]
    The callsig of the specified controller. If empty then the logged in controller callsign.
  • $atisairport
    The ICAO code of the airport selected to be served with voice ATIS in the Voice ATIS dialog.
  • $atiscode
    The actual ATIS letter specified in the _Voice_ATIS_ dialog.
  • $bear(position)
    It returns the bearing of the selected aircraft to the specified position. Position can be vor, ndb, fix or airport.
  • $calt
    The current altitude of the selected aircraft.
  • $callsign
    The login callsign of the controller.
  • $com, $com1
    The primary frequency of the controller. It will return 199.998 if no primary frequency is selected.
  • $cruise
    The final cruise altitude of the selected aircraft.
  • $dep
    The departure airport of the selected aircraft.
  • $deprwy [(airport ICAO code)]
    A comma separated list of the runways set as active for departures. If no parameter is defined then the assigned departure RWY of the ASEL aircraft.
  • $dist(position)
    It returns the distance of the selected aircraft to the specified position. Position can be vor, ndb, fix or airport.
  • $freq[(controller id)]
    If no parameter is given then it returns the primary frequency of the logged in controller (actually the same as $com). If parameter is specified then it returns the primary frequency of the specified controller.
  • $ftime(minutes)
    The actual GMT time plus the specified minutes. Formatted to seconds.
  • $lc(anything)
    It simply makes the parameter to be lowercase.
  • $metar(station)
    The complete METAR string of the station. When you first call this function it may return an empty string. It is because when the METAR is needed EuroScope asks for it from the servers, but the evaluation is not suspended to wait for the result. Therefore and empty string will come, but next time as the METAR arrives it will be displayed correctly.
  • $myrealname
    The real name of the controller. Actually the name you specified in the login dialog.
  • $oclock(position)
    It returns the relative bearing of the selected aircraft to the specified position based on the current heading of the selected aircraft. Position can be vor, ndb, fix or airport.
  • $radioname[(controller ID)]
    If no parameter is specified then returns the radio name of the active controller. Otherwise it looks for the controller based on the short ID. The radio names are defined in the POSITIONS section of the ESE file.
  • $route
    The route string from the flight plan of the selected aircraft.
  • $sid
    The assigned or assumed SID of the selected aircraft.
  • $squawk
    The squawk of the selected aircraft.
  • $star
    The assigned or assumed STAR of the selected aircraft.
  • $temp
    The temporary altitude of the selected aircraft.
  • $time
    The actual GMT time in seconds without the Z sign.
  • $type [(callsign)]
    The type of the selected aircraft. If the callsign is empty then the type of the ASEL aircraft.
  • $uc(anything)
    It simply makes the parameter to be uppercase.
  • $wind [(airport)], $winds [(airport)]
    The wind component of the METAR of the selected station. For availability see $metar. If no airport is defined then looks for the selected aircraft. On the ground it displays the departure airport metar, otherwise the destination airport.

Previous: Command Line Reference Actual: Built In Functions Next: Tower View
Personal tools
Tower view
FAQ